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>'

[ { "id": 123, "externalId": "string", "description": "Example description", "settings": [ "string" ], "color": "#083E5D", "client": { "id": 123, "identifier": "string", "settings": [ "string" ], "subClients": [ { "id": null, "externalId": null, "description": null, "settings": null, "color": null, "client": null, "createdBy": null, "updatedBy": null, "createdAt": null, "updatedAt": null, "defaultColor": null, "subClient": null } ], "subClientsModuleEnabled": true, "archiveModuleEnabled": true, "client": { "id": 123, "identifier": "string", "settings": [ null ], "subClients": [ null ], "subClientsModuleEnabled": true, "archiveModuleEnabled": true, "client": { "id": null, "identifier": null, "settings": null, "subClients": null, "subClientsModuleEnabled": null, "archiveModuleEnabled": null, "client": null, "subClient": null }, "subClient": "https://example.com/" }, "subClient": "https://example.com/" }, "createdBy": "user1@company.com", "updatedBy": "user1@company.com", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "defaultColor": "string", "subClient": "https://example.com/" } ]

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",
    "settings": [
      "string"
    ],
    "color": "#083E5D",
    "client": {
      "id": 123,
      "identifier": "string",
      "settings": [
        "string"
      ],
      "subClients": [
        {
          "id": null,
          "externalId": null,
          "description": null,
          "settings": null,
          "color": null,
          "client": null,
          "createdBy": null,
          "updatedBy": null,
          "createdAt": null,
          "updatedAt": null,
          "defaultColor": null,
          "subClient": null
        }
      ],
      "subClientsModuleEnabled": true,
      "archiveModuleEnabled": true,
      "client": {
        "id": 123,
        "identifier": "string",
        "settings": [
          null
        ],
        "subClients": [
          null
        ],
        "subClientsModuleEnabled": true,
        "archiveModuleEnabled": true,
        "client": {
          "id": null,
          "identifier": null,
          "settings": null,
          "subClients": null,
          "subClientsModuleEnabled": null,
          "archiveModuleEnabled": null,
          "client": null,
          "subClient": null
        },
        "subClient": "https://example.com/"
      },
      "subClient": "https://example.com/"
    },
    "createdBy": "user1@company.com",
    "updatedBy": "user1@company.com",
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "defaultColor": "string",
    "subClient": "https://example.com/"
  }
]

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

settings

string | null[]

color

string

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

Example: "#083E5D"

client

value | null

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"

defaultColor

string

subClient

string<iri-reference> | null

Example: "https://example.com/"