Get Redemption Code Group

Returns a single redemption code group by ID

Returns a single redemption code group by ID.

GEThttps://example.thoughtindustries.com/incoming/v2/redemptionCodes/:id

Example request

curl "https://example.thoughtindustries.com/incoming/v2/redemptionCodes/:id" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

Name	Type	Required	Location	Description
`id`	`uuid`	Yes	path	Redemption code group UUID.

Example response

{
  "id": "rc100000-1111-2222-3333-444455556666",
  "label": "Spring Promo",
  "redeemedCodesCount": 18,
  "totalCodesCount": 100,
  "expirationDate": "2025-06-30T23:59:59.000Z",
  "accessDays": 90,
  "accessExpirationDate": null,
  "uploaded": false,
  "gift": false,
  "client": null,
  "courses": [
    {
      "id": "8f2a1c34-5b6d-4e7f-9a01-2b3c4d5e6f70",
      "title": "Onboarding Essentials"
    }
  ],
  "learningPaths": [],
  "bundles": [],
  "licenses": []
}

Response fields

Field	Type	Description
`id`	`uuid`	Group ID.
`label`	`string`	Group label.
`redeemedCodesCount`	`integer`	Number of codes redeemed.
`totalCodesCount`	`integer`	Total codes in group.
`expirationDate`	`ISO 8601 date`	When codes expire.
`accessDays`	`integer`	Days of access after redemption.
`accessExpirationDate`	`ISO 8601 date`	Absolute access expiry.
`uploaded`	`boolean`	True if codes were imported (vs generated).
`gift`	`boolean`	Whether group is gift-type.
`client`	`object`	{ id, name } or null.
`courses`	`object[]`	Array of { id, title }.
`learningPaths`	`object[]`	Array of { id, name }.
`bundles`	`object[]`	Array of { id, name }.
`licenses`	`object[]`	Array of { id, name }.