Skip to main content
GET
/
api
/
v1
/
product_catalogues
/
promotional-entitlements
/
{id}
/
customers
cURL
curl -X GET "https://api.metrifox.com/api/v1/product_catalogues/promotional-entitlements/625f5cee-259b-4994-b7eb-416b9e551f2c/customers?status=granted" \
  -H "x-api-key: your_api_key"
{
  "statusCode": 200,
  "message": "Promotional entitlement customers fetched",
  "meta": {
    "total_count": 1,
    "total_pages": 1
  },
  "data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "customer_id": "f4a2f74c-661b-428c-87f8-75cc1aa19c4c",
      "customer_key": "cust_001",
      "customer_name": "Acme Inc",
      "customer_email": "billing@acme.test",
      "active": true,
      "applied_at": "2026-06-01T10:00:00Z",
      "revoked_at": null,
      "created_at": "2026-06-01T10:00:00Z"
    }
  ],
  "errors": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.metrifox.com/llms.txt

Use this file to discover all available pages before exploring further.

Filter by status=granted or status=revoked to narrow results, and use search to match on customer name or customer key. Results are paginated — check the meta object for total_count and total_pages.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

The unique identifier of the promotional entitlement

Query Parameters

​
status
enum<string>

Filter assignments by status. Omit to return both granted and revoked assignments.

Available options:
granted,
revoked
​
search
string

Filter by customer name or customer key

Response

Customers for the promotional entitlement

​
statusCode
integer
Example:

200

​
message
string
Example:

"Promotional entitlement customers fetched"

​
meta
object

Pagination metadata

​
data
any[]
​
errors
object