GET
/
promo_codes
/
{id}
Get promo code by id
curl --request GET \
  --url https://v2.firstpromoter.com/api/v2/company/promo_codes/{id} \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "code": "<string>",
  "reward": {
    "id": 123,
    "name": "<string>"
  },
  "ext_id": "<string>",
  "description": "<string>",
  "company_id": 123,
  "promoter_campaign_id": 123,
  "metadata": {},
  "details": {},
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys

Headers

Account-ID
string
required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Path Parameters

id
integer
required

ID of the promo code

Response

Promo code details

id
integer

ID of the promo code entry

code
string

Code of the promo code

reward
object

Reward

ext_id
string
description
string

Description of the promo code

company_id
integer
promoter_campaign_id
integer

ID of the promoter campaign

metadata
object

Metadata of the promo code

details
object

Details of the promo code

archived_at
string<date-time>