Skip to Content
Developers
Pro Deals

List Pro Deals

GET
/pro-deals

The brand's Pro Deals, newest first.

Authorization

integrationKey
headerAuthorizationBearer <token>

A brand integration key, created by an Owner or Admin in Brand Settings › Integrations and shown once. endvr_ik_test_… keys write test data that is never billed; endvr_ik_live_… keys are live.

Query Parameters

status?string

Only Pro Deals in this status.

Value in"draft""scheduled""live""paused""finished"
cursor?string

The nextCursor of the previous page. Omit for the first page.

limit?integer

Items per page.

Range1 <= value <= 100
Default50

Response Body

A page of Pro Deals.

application/json
  1. response
data*array<>
nextCursor*|

Pass it as cursor for the next page; null on the last page.

Example Request
curl -X GET 'https://api.endvr.io/v1/pro-deals'
Example Response
{  "data": [    {      "id": "string",      "title": "string",      "status": "draft",      "discount": {        "type": "percentage",        "value": 0      },      "codesPerAssociate": 1,      "codeSource": "generated",      "codesReady": true,      "codes": {        "total": 0,        "available": 0,        "assigned": 0,        "used": 0,        "deactivated": 0      },      "startsAt": "2019-08-24T14:15:22Z",      "endsAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": "string"}