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

Accessible to CP and TPP companies.

Retrieve the details of the company using the API.

X-API-Key found in header

Response

ExamplesSchema

Successful Response

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

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.

name

string

marketplace_url

string

configuration

object (configuration)

font_family

string

description

string

Request

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

Response

ExamplesSchema

Successful Response

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

Was this page helpful?