Docs
Get Resource States
GET /resource-states
GET
/resource-statesRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Organization token | x-Organization-Token | Optional | Run **Authorize Organization** in the Authorization folder. |
Returns the resource states, ordered by sortOrder. States are what rules put a resource into and what rate card rows price.
Requires
ResourceTypeDatabase.Read permission.Response Fields
| Field | Type | Description |
|---|---|---|
| id | Guid | The state. |
| name | string | Name. |
| color | string | Color token. |
| icon | string | Icon identifier. |
| sortOrder | int | Server-managed order. |
| isArchived | bool | Archived states aren't offered for new selections. |
| isInUse | bool | Referenced by a threshold, rule, rate or state record. |