Get Client Details

GET 
/backend/api/clients/:client_id

Host: https://core.ocplanet.cloud

Retrieve detailed information about a specific client identified by ID.

Request

Responses

200

application/json

Schema

Schema

address1 stringrequired
address2 stringrequired
city stringrequired
company stringrequired
country stringrequired
country_name stringrequired
credits object[]required
Array [
amount stringrequired
client integerrequired
currency stringrequired
]
currency stringrequired
custom_fields arrayrequired
date_created stringrequired
fax nullrequired
first_name stringrequired
has_openstack_services booleanrequired
id integerrequired
last_name stringrequired
long_name stringrequired
name stringrequired
phone stringrequired
roles object[]required
Array [
display_name stringrequired
id integerrequired
name stringrequired
]
state stringrequired
status stringrequired
users integer[]required
vat_id stringrequired
zip_code stringrequired

Example (from schema)

{
  "address1": "string",
  "address2": "string",
  "city": "string",
  "company": "string",
  "country": "string",
  "country_name": "string",
  "credits": [
    {
      "amount": "string",
      "client": 0,
      "currency": "string"
    }
  ],
  "currency": "string",
  "custom_fields": [
    null
  ],
  "date_created": "string",
  "first_name": "string",
  "has_openstack_services": true,
  "id": 0,
  "last_name": "string",
  "long_name": "string",
  "name": "string",
  "phone": "string",
  "roles": [
    {
      "display_name": "string",
      "id": 0,
      "name": "string"
    }
  ],
  "state": "string",
  "status": "string",
  "users": [
    0
  ],
  "vat_id": "string",
  "zip_code": "string"
}

Example

{
  "id": 933016,
  "name": "EN EN",
  "first_name": "EN",
  "last_name": "EN",
  "company": "",
  "city": "Kyiv",
  "country": "UA",
  "state": "Kyivska",
  "date_created": "2024-03-14T07:36:05.561810Z",
  "currency": "EUR",
  "phone": "+380xxxxxxxxx",
  "country_name": "Ukraine",
  "long_name": "EN EN",
  "fax": null,
  "users": [
    786018
  ],
  "address1": "Bogdana 28",
  "address2": "",
  "zip_code": "00000",
  "vat_id": "",
  "credits": [
    {
      "client": 933016,
      "currency": "EUR",
      "amount": "100.00"
    }
  ],
  "custom_fields": [],
  "has_openstack_services": true,
  "status": "active",
  "roles": [
    {
      "id": 1,
      "name": "Owner",
      "display_name": "Owner"
    }
  ]
}

Loading...