Skip to main content
GET
/
sequences
/
{sequenceId}
/
waitlist
/
consumers
cURL
curl --request GET \
  --url https://admin.fanfare.io/api/sequences/{sequenceId}/waitlist/consumers \
  --header 'Authorization: Bearer <token>'
[
  {
    "consumer": {
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "emailVerified": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phoneVerified": true,
      "activityRank": 0,
      "activityScore": 0,
      "activityScoreUpdatedAt": "2023-11-07T05:31:56Z",
      "aov": "0",
      "email": "[email protected]",
      "engagedCount": 0,
      "fullName": "<string>",
      "lastEngagedAt": "2023-11-07T05:31:56Z",
      "lastGeoAt": "2023-11-07T05:31:56Z",
      "lastGeoCity": "<string>",
      "lastGeoCoordinates": {
        "latitude": 123,
        "longitude": 123
      },
      "lastGeoCountry": "<string>",
      "lastGeoPostalCode": "<string>",
      "lastGeoRegion": "<string>",
      "lastGeoSource": "<string>",
      "lastGeoTimezone": "<string>",
      "lastLoginAt": "2023-11-07T05:31:56Z",
      "lastOrderAt": "2023-11-07T05:31:56Z",
      "lastReturnAt": "2023-11-07T05:31:56Z",
      "loyaltyBalance": 0,
      "loyaltyLastActivityAt": "2023-11-07T05:31:56Z",
      "loyaltyLifetimePoints": 0,
      "ltv": "0",
      "metadata": {},
      "monetaryRank": 0,
      "monetaryScore": 0,
      "monetaryScoreUpdatedAt": "2023-11-07T05:31:56Z",
      "phone": "<string>",
      "primaryExternalId": "<string>",
      "primaryLastSyncedAt": "2023-11-07T05:31:56Z",
      "primarySourceVendor": "<string>",
      "primarySyncSourceId": "<string>",
      "purchaseFrequencyRank": 0,
      "purchaseFrequencyScore": 0,
      "purchaseFrequencyScoreUpdatedAt": "2023-11-07T05:31:56Z",
      "smsOptOut": false,
      "totalEngagements": 0,
      "totalMessages": 0,
      "totalOrders": 0,
      "totalReturns": 0,
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "verificationCode": "<string>",
      "verificationCodeExpiresAt": "<string>"
    },
    "consumerId": "<string>",
    "enteredAt": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "waitlistId": "<string>",
    "notifiedAt": "<string>",
    "updatedAt": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Fanfare secret key. Keep secret credentials on your server.

Path Parameters

​
sequenceId
string
required

Response

Waitlist consumers retrieved successfully

​
consumer
object
required
​
consumerId
string
required
​
enteredAt
string
required
​
id
string<uuid>
required
​
organizationId
string<uuid>
required
​
status
enum<string>
required
Available options:
entered,
notified,
expired,
left
​
waitlistId
string
required
​
notifiedAt
string | null
​
updatedAt
string | null