Company

Download Spec

Get Company

get /private/dashboard/cp/company

Accessible to CP and TPP companies.

Retrieve the details of the company using the API.

Authentication

API Key ApiKey

X-API-Key found in header

Responses

200

Successful Response

Response: application/json

configuration

object (configuration)

required

description

string

font_family

string

required

marketplace_url

string

name

string

required

Update Company

post /private/dashboard/cp/company

⚠ Accessible to CP (TPP to be implemented at a later date).

Retrieve the details of the company using the API.

Authentication

API Key ApiKey

X-API-Key found in header

Request Body

application/json

configuration

object (configuration)

description

string

font_family

string

marketplace_url

string

name

string

Responses

200

Successful Response

Response: application/json

configuration

object (configuration)

required

description

string

font_family

string

required

marketplace_url

string

name

string

required

422

Validation Error

Response: application/json

detail

array[object (ValidationError)]

Show child attributes +

ValidationError

object (ValidationError)

Show child attributes +

loc

array[Any Of]

required

Show child attributes +

Any Of

Must match any of the following +

string

int

msg

string

required

type

string

required

Request Examples

Was this page helpful?