Skip to Content
OpenRoam Docs
Gift cards

List gift card categories

Lists the gift card categories with their display names.

GET
/v1/giftcards/categories

Lists the gift card categories with their display names.

Returns the complete list { items: [{ category, name }] }, without paging. Use a category value to filter search and the catalog. The route takes no query parameters.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Response Body

OK

  1. response

The complete category reference list. The taxonomy is small and fixed, so it is not paged.

items*array<>
Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/giftcards/categories'
Example Response
{  "items": [    {      "category": "shopping",      "name": "string"    }  ]}