Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| offset | query integer (int32) | Number of records to skip (default: 0). Use with limit for pagination. |
Number of records to skip (default: 0). Use with limit for pagination. |
||
| limit | query integer (int32) | Maximum number of records to return (default: 10, max: 50) |
Maximum number of records to return (default: 10, max: 50) |
||
| sortBy | query enum | Field to sort by. Valid values depend on the resource. |
Field to sort by. Valid values depend on the resource. |
||
| sortDesc | query boolean | Sort in descending order (true) or ascending order (false, default) |
Sort in descending order (true) or ascending order (false, default) |
||
| entityType | query string | Filter by entity type |
Filter by entity type |
||
| dataType | query string | Filter by data type |
Filter by data type |
||
| clientType | query string | Filter by applicable client type. Returns fields that explicitly include this type, or have no types specified (applicable to all). |
Filter by applicable client type. Returns fields that explicitly include this type, or have no types specified (applicable to all). |
||
| clientCode | query string | Filter by the services this client holds. Returns fields restricted to one of the client's services, or with no service restriction at all. Combine with clientType for the full applicability check. |
Filter by the services this client holds. Returns fields restricted to one of the client's services, or with no service restriction at all. Combine with clientType for the full applicability check. |
||
| isArchived | query boolean | Filter by archived status (true = archived only, false = active only) |
Filter by archived status (true = archived only, false = active only) |
||
| search | query string | Search across field code and label (minimum 3 characters) |
Search across field code and label (minimum 3 characters) |
||