SubClient

Retrieves a SubClient resource.

GET/api/spa/sub-clients/{id}

Retrieves a SubClient resource.

curl --request GET \
  --url 'https://app.output.rocks/api/spa/sub-clients/string' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

{
  "id": 123,
  "externalId": "string",
  "description": "Example description",
  "color": "#083E5D",
  "createdBy": "user1@company.com",
  "updatedBy": "user1@company.com",
  "createdAt": "2024-08-23T00:00:00+00:00",
  "updatedAt": "2024-08-23T00:00:00+00:00"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

stringrequired

SubClient identifier

Response

200application/json

SubClient resource

integer

externalId

string | null

description

string

color

string

HTML color code to be used on Dashboard-charts and statistics.

Example: "#083E5D"

createdBy

string

User, created this entry

Example: "user1@company.com"

updatedBy

string

User, updated this entry

Example: "user1@company.com"

createdAt

string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt

string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"