Read a status
Get a status by key¶
GET https://api.stativate.de/v1/status-keys/:statusKey
Required authorization level: Verified
Description¶
Returns one status based on the requested status key. Only the owner of a status can request it via API.
Info
See the docs on status identifiers to learn if using status id or status key is best for your case.
Request Path - Parameters¶
| Name | Type | Description |
|---|---|---|
| :statusKey | String | The status Key of the status |
Response Body - Parameters¶
| Name | Type | Description |
|---|---|---|
| id | string | The status id |
| shareID | string | The share id for the status |
| name | string | Status name |
| type | string | Status type |
| value | string | Status value |
| accessType | string | Status access type |
| description | string | Status description text |
| colorNo | number | Status color as a number |
| accessTypeUserList | string | Level of access to the user list of this status Check availability in your plan |
| accessTypeHistory | string | Level of access to the history of this status Check availability in your plan |
Success response examples¶
Success response example - Success (200):¶
{
"id": "SPbi7aNV4s0w0BExample",
"shareId": "7v7x3e",
"name": "Delivery Order #1234",
"value": "TODAY",
"type": "text",
"accessType": "private",
"description": "We will keep you updated about your order #1234 here.",
"colorNo": 3,
"accessTypeUserList": "owners",
"accessTypeHistory": "private"
}