OAuth Operations
Propello Cloud API (3.0.0)
The Propello API has been created to allow organisations to interact with the Propello platform. There are a lot of different options available to integrators but we will aim to introduce these over the next few sections to help you get up and running quickly.
The rate limit is set to 120 calls per minute, however this can be changed upon request. Please speak to your Customer Success Manager to arrange this. You can view your current rate limit in the CMS in the group settings under the “Integration” tab.
If you have any questions around the integration or onboarding, please email tech@propellocloud.com
| SDKs |
|---|
| PHP |
| JavaScript |
Download OpenAPI description
Languages
Servers
Mock server
https://propello-cloud.redocly.app/_mock/openapi
Bodyapplication/json
If accessing via an organisation level token you will need to provide an organisation group id in order to indicate which group you are requesting.
- Mock serverhttps://propello-cloud.redocly.app/_mock/openapi/v3/group
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://propello-cloud.redocly.app/_mock/openapi/v3/group \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"organisation_group_id": 1
}'Response
application/json
{ "status": 200, "timestamp": "1970-01-30T00:00:00.000000Z", "data": { "id": 1, "name": "example_org", "display_name": "Example Org. LTD", "sandbox": 0, "locale": "en_GB", "timezone": "Europe/London", "custom_domain": null, "subdomain": "example" } }
- Mock serverhttps://propello-cloud.redocly.app/_mock/openapi/v3/group/list
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://propello-cloud.redocly.app/_mock/openapi/v3/group/list \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'OK
Example: [{"id":1,"name":"example_org","display_name":"Example Org. LTD","sandbox":0,"locale":"en_GB","timezone":"Europe/London","custom_domain":null,"subdomain":"example"},{"id":2,"name":"example_org_sandbox","display_name":"Sandbox Example Org. LTD","sandbox":1,"locale":"en_GB","timezone":"Europe/London","custom_domain":null,"subdomain":"example-sandbox"}]
Response
application/json
{ "status": 200, "timestamp": "1970-01-30T00:00:00.000000Z", "data": [ { … }, { … } ] }