Download OpenAPI specification:Download
Most of the endpoints require authentication. Authenticating is done with an Bearer Token in the Authorization
header.
curl -H 'Authorization: Bearer my_authentication_token'
Authentication tokens are used to identify the user your application is connecting to the Cherry Servers API on behalf of. Think of authentication tokens as permanent sessions—the user creates authentication tokens, and your app can use them to connect to the API on their behalf until they delete the token.
Users can create authentication tokens in the Cherry Server client portal.
Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with internal servers.
200, 201, 204 | Everything worked as expexted. |
400 | Bad parameters or request can't be made. |
401 | No valid API key provided. |
403 | Insufficient permissions to access resource. |
404 | Resource doesn't exist. |
500 | Something went wrong. |
List parameters:
Limit Ofset X-Total-Count header
More params:
query parameter fields
planId required | string Default: "images,pricing" |
fields required | string\d+ Default: "images,pricing" |
limit | string\d+ Default: "0" |
offset | string\d+ Default: "0" |
[- {
- "id": 0,
- "name": "string",
- "pricing": {
- "id": 0,
- "currency": "string",
- "unit": "string",
- "unit_price": 0,
- "discount": 0,
- "discount_percentage": true,
- "price_subtotal": 0,
- "taxed": true,
- "price_total": 0,
- "price": 0
}
}
]
teamId required | string Default: "images,pricing" |
planId required | string\d+ Default: "0" |
fields required | string\d+ Default: "images,pricing" |
limit | string\d+ Default: "0" |
offset | string\d+ Default: "0" |
[- {
- "id": 0,
- "name": "string",
- "pricing": {
- "id": 0,
- "currency": "string",
- "unit": "string",
- "unit_price": 0,
- "discount": 0,
- "discount_percentage": true,
- "price_subtotal": 0,
- "taxed": true,
- "price_total": 0,
- "price": 0
}
}
]
teamId required | string Default: "invitation,href" |
fields required | string\d+ Default: "invitation,href" |
limit | string\d+ Default: "0" |
offset | string\d+ Default: "0" |
[- {
- "id": 0,
- "href": "string",
- "invitee": "string",
- "message": "string",
- "updated": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "invited_by": {
- "href": "string"
}, - "team": {
- "href": "string"
}, - "roles": [
- {
- "role": "string"
}
], - "projects": [
- {
- "href": "string"
}
]
}
]
teamId required | string Default: "invitation,href" |
fields required | string Default: "invitation,href" |
email required | string invitee email |
message required | string Default: "" |
projects | Array of integers List of team projects |
roles required | Array of strings |
{- "email": "string",
- "message": "",
- "projects": [
- 0
], - "roles": [
- "ROLE_COLLABORATOR",
- "ROLE_BILLING"
]
}
{- "id": 0,
- "href": "string",
- "invitee": "string",
- "message": "string",
- "updated": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "invited_by": {