Clients
GET/Clients
MCP tool
get_clientsCore licenseReturns the clients set up in the Clients module that your API user can access. Use the id of each client as the {id} path parameter on every other endpoint.
Parameters
| Name | In | Type | Description | |
|---|---|---|---|---|
tenantId | query | string | optional | Tenant to query, from /Tenants. Default: your user's main tenant. |
Example request
Response
| Field | Type | Description |
|---|---|---|
id | integer | Internal client code. Use it as {id} on other endpoints. |
clientID | string | Alphanumeric ID assigned in the Clients module. Appears as clientID on data rows. |
name | string | First, middle and last name assigned in the Clients module. |
clientAlias | string | Alias assigned in the Clients module. |
Errors
| Status | Body |
|---|---|
400 | "The user does not have access to this tenant or the tenant does not exist." |
Plus the common 401 and 429 responses. See Errors.