# 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.
<br><br>
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.
<br><br>
If you have any questions around the integration or onboarding, please email [tech@propellocloud.com](mailto:tech@propellocloud.com)
<br><br>
| 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

OAuth Operations

### Generate Access Tokens

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

## User

User Operations

### Create a new user record

 - [POST /v3/user/create](https://propello-cloud.redocly.app/openapi/user/create-user.md)

### Bulk create new user records (limit 100)

 - [POST /v3/user/create/bulk](https://propello-cloud.redocly.app/openapi/user/bulk-create-user.md)

### Retrieve a users details

 - [POST /v3/user/get/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/get-user-detail.md)

### Retrieve a list of users

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

### Update a user record

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

### Deactivate a user record

 - [DELETE /v3/user/delete/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/delete-user.md)

### Restore a deactivated user record

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

### Generate a single-use user login link

 - [POST /v3/user/login-url/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/login-url.md)

### Create a user and return a single-use login URL

 - [POST /v3/user/create/login-url](https://propello-cloud.redocly.app/openapi/user/create-login-url.md)

### Delete user and remove identifiable information

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

### Restore previously anonymised user

 - [POST /v3/user/make-known/{identifier}/{identifier_value}](https://propello-cloud.redocly.app/openapi/user/make-known-user.md)

## Group

Organisation Group Operations

### Get Group Details

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

### Get Groups List

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

## Offer

Organisation Offer Operations

### Get Offer Details

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

### Get Offer List

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