Journey Docs
Partner API ExplorerFulfillments

List fulfillments

Required scopepartner:fulfillments:read
GET
/v1/partner/fulfillments

Fulfillments in reach of the credential, newest first.

Authorization

headerAuthorizationBearer <token>

WorkOS access token (JWT) for a user who is a member of the partner organization. The organization the request is scoped to is taken from the token, not from a header or query parameter.

Only a JWT is accepted in this header. A Journey jny_ API key sent as a bearer token is rejected with 401 Invalid or expired token; send it in X-API-Key instead.

WorkOS organization API keys are not accepted yet.

Query Parameters

limit?integer
Range1 <= value
offset?integer
Range0 <= value
organizationId?string

External organization id (HXP UUID or WorkOS organization id). Only Journey superadmin callers may set it; for a partner credential the organization is taken from the credential and this parameter is ignored.

propertyId?integer

Narrow to one property. This is the internal numeric property id, not an external id — the same integer HXP uses in X-Emulate-Property-Ids.

status?string

Comma-separated statuses to include.

Response Body

A page of fulfillments.

application/json
  1. response
items*array<>
limit?number
offset?number
pendingApprovalCount?number
total*number
curl -X GET 'https://api-prd.cf.journey.com/v1/partner/fulfillments'
{  "items": [    {      "approvalStatus": "string",      "canApprove": true,      "claimedAt": "string",      "contactEmail": "string",      "createdAt": "string",      "displayName": "string",      "expiresAt": "string",      "fulfilledAt": "string",      "id": "string",      "memberId": 0,      "offerDescription": "string",      "offerId": "string",      "offerImageUrl": "string",      "offerName": "string",      "organizationId": 0,      "organizationName": "string",      "perkDescription": "string",      "perkId": 0,      "perkImageUrl": "string",      "perkName": "string",      "pointsCharged": 0,      "propertyId": 0,      "propertyName": "string",      "qrCodeUrl": "string",      "redemptionType": "string",      "requestedCheckInTime": "string",      "requestedCheckOutTime": "string",      "reservationId": 0,      "retailValue": 0,      "source": "string",      "status": "string",      "updatedAt": "string",      "verificationCode": "string"    }  ],  "limit": 0,  "offset": 0,  "pendingApprovalCount": 0,  "total": 0}