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.

API Key ApiKey

X-API-Key found in header

Response

Examples Schema

Successful Response

{
  "configuration": {},
  "description": "string",
  "font_family": "string",
  "id": "string",
  "marketplace_url": "string",
  "name": "string"
}

configuration

object (configuration)

required

description

string

font_family

string

id

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.

API Key ApiKey

X-API-Key found in header

configuration

object (configuration)

description

string

font_family

string

marketplace_url

string

name

string

Request

{
  "configuration": {},
  "description": "string",
  "font_family": "string",
  "marketplace_url": "string",
  "name": "string"
}

Response

Examples Schema

Successful Response

{
  "configuration": {},
  "description": "string",
  "font_family": "string",
  "id": "string",
  "marketplace_url": "string",
  "name": "string"
}

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

configuration

object (configuration)

required

description

string

font_family

string

id

string

required

marketplace_url

string

name

string

required

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Was this page helpful?