Propello Cloud API (3.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

SDKs
PHP
JavaScript

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

https://propello-cloud.redocly.app/_mock/openapi

OAuth
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

OAuth Operations

Operations

User
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

User Operations

Operations

Group
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Organisation Group Operations

Operations

Offer
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Organisation Offer Operations

Operations

Get Offer Details

Request

Security

BearerAuth

Path

idinteger

Example: 1

curl -i -X POST \
  https://propello-cloud.redocly.app/_mock/openapi/v3/offers/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

statusinteger

Example: 200

timestampstring

Example: "1970-01-30T00:00:00.000000Z"

dataobject

Response

application/json

{
  "status": 200,
  "timestamp": "1970-01-30T00:00:00.000000Z",
  "data": {
    "id": 1,
    "partner_id": 1,
    "title": "Offer example - get amount off.",
    "overview": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>",
    "terms": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>",
    "faq": "<p>FAQ: Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>",
    "how_to_redeem": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n</p>",
    "offer": "Save amount",
    "redemption_in_store": false,
    "redemption_online": true,
    "redemption_selected_stores": true,
    "image": "https://example.yourperx.com/storage/perx/15/151521222306.jpg",
    "offer_link": "https://example.yourperx.com/perk/1"
  }
}

Get Offer List

Request

Security

BearerAuth

curl -i -X POST \
  https://propello-cloud.redocly.app/_mock/openapi/v3/offers/list \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

statusinteger

Example: 200

timestampstring

Example: "1970-01-30T00:00:00.000000Z"

dataArray of objects

current_pageinteger

Example: 1

first_page_urlstring

Example: "https://{url}/v3/offers/list?page=2"

last_page_urlstring

Example: "https://{url}/v3/offers/list?page=15"

next_page_urlstring

Example: "https://{url}/v3/offers/list?page=3"

prev_page_urlstring

Example: "https://{url}/v3/offers/list?page=1"

frominteger

Example: 4

last_pageinteger

Example: 15

pathstring

Example: "https://{url}/v3/offers/list"

per_pageinteger

Example: 3

tointeger

Example: 6

totalinteger

Example: 45

Response

application/json

{
  "status": 200,
  "timestamp": "1970-01-30T00:00:00.000000Z",
  "data": [
    { … }
  ],
  "current_page": 1,
  "first_page_url": "https://{url}/v3/offers/list?page=2",
  "last_page_url": "https://{url}/v3/offers/list?page=15",
  "next_page_url": "https://{url}/v3/offers/list?page=3",
  "prev_page_url": "https://{url}/v3/offers/list?page=1",
  "from": 4,
  "last_page": 15,
  "path": "https://{url}/v3/offers/list",
  "per_page": 3,
  "to": 6,
  "total": 45
}

Propello Cloud API (3.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Overview:

OAuth
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

User
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Group
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Offer
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Get Offer Details

Request

Responses

Was this helpful?

Get Offer List

Request

Responses

Was this helpful?

Propello Cloud API (3.0.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Overview:

OAuthCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

UserCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

GroupCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

OfferCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Get Offer Details

Request

Responses

Was this helpful?

Get Offer List

Request

Responses

Was this helpful?

Propello Cloud API (3.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

OAuth
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

User
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Group
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Offer
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude