# Propello Cloud API

# Overview:
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](mailto:tech@propellocloud.com)

| SDKs |
|  --- |
| [PHP](https://packagist.org/packages/propellocloud/propello-php-sdk) |
| [JavaScript](https://www.npmjs.com/package/yourperx) |

Version: 3.0.0

## Security

### BearerAuth

To authenticate requests, provide a Bearer token in the `Authorization` header. Example: `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`. You can obtain a token via the Authorise endpoint.

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

 - [Propello Cloud API](https://propello-cloud.redocly.app/_bundle/openapi.yaml)

## OAuth

 - [POST /v3/oauth/token](https://propello-cloud.redocly.app/openapi/oauth/oauth-request.md)
## User

 - [POST /v3/user/create](https://propello-cloud.redocly.app/openapi/user/create-user.md)
 - [POST /v3/user/create/bulk](https://propello-cloud.redocly.app/openapi/user/bulk-create-user.md)
 - [POST /v3/user/get/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/get-user-detail.md)
 - [POST /v3/user/list](https://propello-cloud.redocly.app/openapi/user/get-user-list.md)
 - [POST /v3/user/update/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/update-user.md)
 - [DELETE /v3/user/delete/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/delete-user.md)
 - [POST /v3/user/restore/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/restore-user.md)
 - [POST /v3/user/login-url/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/login-url.md)
 - [POST /v3/user/create/login-url](https://propello-cloud.redocly.app/openapi/user/create-login-url.md)
 - [POST /v3/user/anonymise/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/anonymise-user.md)
 - [POST /v3/user/make-known/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/make-known-user.md)
 - [POST /v3/users/redemption-stats](https://propello-cloud.redocly.app/openapi/user/get-bulk-user-redemption-stats.md)
 - [POST /v3/user/stats/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/get-user-redemption-stats.md)
## Group

 - [POST /v3/group](https://propello-cloud.redocly.app/openapi/group/get-group.md)
 - [POST /v3/group/list](https://propello-cloud.redocly.app/openapi/group/get-group-list.md)
## Offer

 - [POST /v3/offers/get/{id}](https://propello-cloud.redocly.app/openapi/offer/get-offer.md)
 - [POST /v3/offers/list](https://propello-cloud.redocly.app/openapi/offer/get-offer-list.md)
## Credit

 - [POST /v3/credit/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/credit/get-user-credit.md)
 - [POST /v3/credit/add/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/credit/add-user-credit.md): Gives the user credit to spend on the platform. The user must belong to your group. Your group's issuance fee is taken from your float when the credit is added. If your float can't cover the fee, the
## Orders

 - [POST /v3/orders](https://propello-cloud.redocly.app/openapi/orders/list-orders.md)
 - [POST /v3/orders/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/orders/list-user-orders.md)
## Interactions

 - [POST /v3/Interactions/list/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/interactions/get-interaction.md)
 - [POST /v3/Interactions/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/interactions/create-interaction.md)
