Skip to Content
Developers
Pro Deals

List codes

GET
/pro-deals/{id}/codes

The Pro Deal's codes and their state. For a Pro Deal with codeSource: generated, these are the codes to create in your store as single-use discount codes. Send Accept: text/csv for one code per line.

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.

Path Parameters

id*string

Pro Deal id.

Example"6730f1c2a9d4e5b6c7d8e9f0"

Query Parameters

status?string

Only codes in this state.

Value in"available""assigned""used""deactivated"
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 codes.

  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/6730f1c2a9d4e5b6c7d8e9f0/codes'
Example Response
{  "data": [    {      "code": "string",      "status": "available",      "assignedAt": "2019-08-24T14:15:22Z",      "usedAt": "2019-08-24T14:15:22Z",      "deactivatedAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": "string"}