Organisations
Read what priority support is for an organisation
The named contact, the first response target, the support hours and whether the plan has an uptime SLA, for every member; the contract dates for the owner and admins, never its price.
GET
/orgs/{org}/supportTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read what priority support is for an organisation. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type SupportSettings. |
| What can go wrong? | 401 not signed in; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
The named contact, the first response target, the support hours and whether the plan has an uptime SLA, for every member; the contract dates for the owner and admins, never its price. available is false on a plan without priority support.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | What support is for the organisation. | SupportSettings |
| 401 | Not signed in. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type SupportSettings.
| Field | Type | Required | Description |
|---|---|---|---|
available | boolean | yes | True when the organisation's plan includes priority support (Enterprise). |
plan | string | yes | The organisation's plan. |
contact | object | null | yes | The named contact, or null when none is named yet. A request still reaches Plotwork support. |
contact.name | string | yes | |
contact.email | string | yes | |
firstResponseHours | integer | null | yes | The first response target, in business hours, or null when the contract names none. |
hours | string | null | yes | When support is staffed, as the contract says it, or null. |
uptimeSla | boolean | yes | True when the plan includes an uptime SLA. |
contract | object | null | yes | The dates of the contract: for the owner and the admins only, and null for everyone else or a contract set without dates. |
contract.startsOn | string | yes | The first day of the contract, YYYY-MM-DD (UTC). |
contract.endsOn | string | yes | The last day of the contract, YYYY-MM-DD (UTC). |
contract.autoRenew | boolean | yes | Whether the contract renews by itself at the end. |
contract.noticeDays | integer | yes | The notice either side gives before the end, in days. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |