Fetches all SubClients (to be with enabled sub-clients module)

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

200

application/json

[
  {
    "id": 12345,
    "externalId": "id123",
    "description": "Any description"
  }
]

SubClient

This API can be used on instances with enabled sub-clients module only. API fetches all SubClients

GET/api/sub-clients

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

application/json

[
  {
    "id": 12345,
    "externalId": "id123",
    "description": "Any description"
  }
]

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

externalId

string

The external ID of the sub-client

200application/json

SubClient collection

integer

Identifier generated by Output.Rocks.

Example: 12345

externalId

string

Optional identifier, used in connected system. External ID has to be unique.

Example: "id123"

description

string

SubClient description

Example: "Any description"