SubClient

Retrieves the collection of SubClient resources.

GET/api/spa/sub-clients

Retrieves the collection of SubClient resources.

curl --request GET \
  --url 'https://app.output.rocks/api/spa/sub-clients?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5BexternalId%5D=asc&order%5Bdescription%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 123,
    "externalId": "string",
    "description": "Example description",
    "color": "#083E5D",
    "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.

Query Parameters

page

integerdefault:1

The collection page number

itemsPerPage

integerdefault:20

The number of items per page

pagination

boolean

Enable or disable pagination

order[id]

stringdefault:asc

No description provided.

order[externalId]

stringdefault:asc

No description provided.

order[description]

stringdefault:asc

No description provided.

order[createdAt]

stringdefault:asc

No description provided.

order[updatedAt]

stringdefault:asc

No description provided.

externalId

string

No description provided.

description

string

No description provided.

string

Search across multiple fields (externalId, description) using OR logic with partial matching.

Response

200application/json

SubClient collection

integer

externalId

string | null

description

string

color

string

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

Example: "#083E5D"

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"