Skip to main content
GET
/
experiences
cURL
curl --request GET \
  --url https://admin.fanfare.io/api/experiences \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timeZone": "<string>",
      "accessCode": "<string>",
      "closeAt": "2023-11-07T05:31:56Z",
      "i18n": {},
      "openAt": "2023-11-07T05:31:56Z",
      "product": {
        "archived": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "createdBy": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "<string>",
        "defaultVariantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>",
        "handle": "<string>",
        "metadata": {},
        "primaryExternalId": "<string>",
        "primaryLastSyncedAt": "2023-11-07T05:31:56Z",
        "primarySourceVendor": "<string>",
        "primarySyncSource": {
          "archived": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "createdBy": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "syncSource": "<string>",
          "syncSourceId": "<string>",
          "lastSyncedAt": "2023-11-07T05:31:56Z",
          "sourceData": {},
          "syncStatus": "PENDING",
          "updatedAt": "2023-11-07T05:31:56Z",
          "updatedBy": "<string>"
        },
        "primarySyncSourceId": "<string>",
        "productMediaAssets": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "mediaAsset": {
              "archived": true,
              "createdAt": "2023-11-07T05:31:56Z",
              "createdBy": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "altText": "<string>",
              "description": "<string>",
              "publicUrl": "<string>",
              "sourceUrl": "<string>",
              "thumbnailUrl": "<string>",
              "updatedAt": "2023-11-07T05:31:56Z",
              "updatedBy": "<string>",
              "uploadUrl": "<string>"
            },
            "mediaAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "position": 1,
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "purpose": "<string>"
          }
        ],
        "updatedAt": "2023-11-07T05:31:56Z",
        "updatedBy": "<string>",
        "variants": [
          {
            "options": [
              {
                "optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "optionName": "<string>",
                "value": "<string>",
                "valueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ],
            "archived": true,
            "createdAt": "2023-11-07T05:31:56Z",
            "createdBy": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "inventoryQuantity": 123,
            "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "price": "<string>",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "sku": "<string>",
            "metadata": {},
            "primaryExternalId": "<string>",
            "primaryLastSyncedAt": "2023-11-07T05:31:56Z",
            "primarySourceVendor": "<string>",
            "primarySyncSourceId": "<string>",
            "updatedAt": "2023-11-07T05:31:56Z",
            "updatedBy": "<string>"
          }
        ]
      },
      "products": [
        {
          "experienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "isPrimary": true,
          "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "position": 123,
          "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "product": {
            "archived": true,
            "createdAt": "2023-11-07T05:31:56Z",
            "createdBy": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "url": "<string>",
            "defaultVariantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "<string>",
            "handle": "<string>",
            "metadata": {},
            "primaryExternalId": "<string>",
            "primaryLastSyncedAt": "2023-11-07T05:31:56Z",
            "primarySourceVendor": "<string>",
            "primarySyncSource": {
              "archived": true,
              "createdAt": "2023-11-07T05:31:56Z",
              "createdBy": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "syncSource": "<string>",
              "syncSourceId": "<string>",
              "lastSyncedAt": "2023-11-07T05:31:56Z",
              "sourceData": {},
              "syncStatus": "PENDING",
              "updatedAt": "2023-11-07T05:31:56Z",
              "updatedBy": "<string>"
            },
            "primarySyncSourceId": "<string>",
            "productMediaAssets": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "mediaAsset": {
                  "archived": true,
                  "createdAt": "2023-11-07T05:31:56Z",
                  "createdBy": "<string>",
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "name": "<string>",
                  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "altText": "<string>",
                  "description": "<string>",
                  "publicUrl": "<string>",
                  "sourceUrl": "<string>",
                  "thumbnailUrl": "<string>",
                  "updatedAt": "2023-11-07T05:31:56Z",
                  "updatedBy": "<string>",
                  "uploadUrl": "<string>"
                },
                "mediaAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "position": 1,
                "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "purpose": "<string>"
              }
            ],
            "updatedAt": "2023-11-07T05:31:56Z",
            "updatedBy": "<string>",
            "variants": [
              {
                "options": [
                  {
                    "optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "optionName": "<string>",
                    "value": "<string>",
                    "valueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                  }
                ],
                "archived": true,
                "createdAt": "2023-11-07T05:31:56Z",
                "createdBy": "<string>",
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "inventoryQuantity": 123,
                "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "price": "<string>",
                "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "sku": "<string>",
                "metadata": {},
                "primaryExternalId": "<string>",
                "primaryLastSyncedAt": "2023-11-07T05:31:56Z",
                "primarySourceVendor": "<string>",
                "primarySyncSourceId": "<string>",
                "updatedAt": "2023-11-07T05:31:56Z",
                "updatedBy": "<string>"
              }
            ]
          },
          "productVariant": {
            "archived": true,
            "createdAt": "2023-11-07T05:31:56Z",
            "createdBy": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "inventoryQuantity": 123,
            "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "price": "<string>",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "sku": "<string>",
            "metadata": {},
            "primaryExternalId": "<string>",
            "primaryLastSyncedAt": "2023-11-07T05:31:56Z",
            "primarySourceVendor": "<string>",
            "primarySyncSourceId": "<string>",
            "updatedAt": "2023-11-07T05:31:56Z",
            "updatedBy": "<string>"
          },
          "productVariantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "sequences": [
        {
          "archived": true,
          "color": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "createdBy": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "priority": 123,
          "accessCode": "<string>",
          "announcements": [
            {
              "archived": true,
              "content": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "createdBy": "<string>",
              "experienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "includeAudience": true,
              "includeWaitlist": true,
              "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "timeZone": "<string>",
              "title": "<string>",
              "creativeDesignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "creativeDocument": {
                "body": {},
                "editor": "<string>",
                "schemaVersion": 2,
                "themeOverrides": {
                  "background": "<string>",
                  "danger": "<string>",
                  "fontFamily": "<string>",
                  "fontHeading": "<string>",
                  "headerImageUrl": "<string>",
                  "logoUrl": "<string>",
                  "muted": "<string>",
                  "primary": "<string>",
                  "secondary": "<string>",
                  "success": "<string>",
                  "surface": "<string>",
                  "text": "<string>",
                  "warning": "<string>"
                }
              },
              "creativeTemplateKey": "<string>",
              "imageUrl": "<string>",
              "link": "<string>",
              "metadata": {
                "email": {
                  "fromEmail": "[email protected]",
                  "replyToEmail": "[email protected]",
                  "fromName": "<string>",
                  "replyToName": "<string>"
                }
              },
              "offsetSeconds": 123,
              "scheduledAt": "2023-11-07T05:31:56Z",
              "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "shortContent": "<string>",
              "templateData": {},
              "timingStrategy": "POINT_IN_TIME",
              "updatedAt": "2023-11-07T05:31:56Z",
              "updatedBy": "<string>"
            }
          ],
          "appointments": [
            {
              "archived": true,
              "createdAt": "2023-11-07T05:31:56Z",
              "createdBy": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "timeZone": "<string>",
              "bufferMinutes": 123,
              "closeAt": "2023-11-07T05:31:56Z",
              "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "maxCapacityPerSlot": 123,
              "openAt": "2023-11-07T05:31:56Z",
              "slotDurationMinutes": 123,
              "statusOverride": "ended",
              "statusOverrideAt": "2023-11-07T05:31:56Z",
              "statusOverrideBy": "<string>",
              "updatedAt": "2023-11-07T05:31:56Z",
              "updatedBy": "<string>"
            }
          ],
          "auctions": [
            {
              "archived": true,
              "createdAt": "2023-11-07T05:31:56Z",
              "createdBy": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "settleAt": "2023-11-07T05:31:56Z",
              "timeZone": "<string>",
              "auctionType": "english",
              "autoExtendSeconds": 123,
              "closeAt": "2023-11-07T05:31:56Z",
              "floorPrice": "<string>",
              "minBidIncrement": "<string>",
              "openAt": "2023-11-07T05:31:56Z",
              "priceDropAmount": "<string>",
              "priceDropIntervalSeconds": 123,
              "quantity": 123,
              "reservePrice": "<string>",
              "startPrice": "<string>",
              "statusOverride": "ended",
              "statusOverrideAt": "2023-11-07T05:31:56Z",
              "statusOverrideBy": "<string>",
              "updatedAt": "2023-11-07T05:31:56Z",
              "updatedBy": "<string>"
            }
          ],
          "audienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "draws": [
            {
              "archived": true,
              "createdAt": "2023-11-07T05:31:56Z",
              "createdBy": "<string>",
              "drawAt": "2023-11-07T05:31:56Z",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "timeZone": "<string>",
              "winnerCount": 123,
              "admissionExpirationSeconds": 123,
              "capacity": 123,
              "closeAt": "2023-11-07T05:31:56Z",
              "continueSelectingUntilCompleted": true,
              "loyaltyBiasEnabled": true,
              "openAt": "2023-11-07T05:31:56Z",
              "statusOverride": "ended",
              "statusOverrideAt": "2023-11-07T05:31:56Z",
              "statusOverrideBy": "<string>",
              "updatedAt": "2023-11-07T05:31:56Z",
              "updatedBy": "<string>"
            }
          ],
          "experienceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "queues": [
            {
              "admitRate": 123,
              "archived": true,
              "createdAt": "2023-11-07T05:31:56Z",
              "createdBy": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "timeZone": "<string>",
              "admissionExpirationSeconds": 123,
              "capacity": 123,
              "closeAt": "2023-11-07T05:31:56Z",
              "loyaltyBiasEnabled": true,
              "maxAdmissions": 123,
              "openAt": "2023-11-07T05:31:56Z",
              "statusOverride": "ended",
              "statusOverrideAt": "2023-11-07T05:31:56Z",
              "statusOverrideBy": "<string>",
              "updatedAt": "2023-11-07T05:31:56Z",
              "updatedBy": "<string>"
            }
          ],
          "timedReleases": [
            {
              "archived": true,
              "createdAt": "2023-11-07T05:31:56Z",
              "createdBy": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "supportsGuest": true,
              "timeZone": "<string>",
              "closeAt": "2023-11-07T05:31:56Z",
              "openAt": "2023-11-07T05:31:56Z",
              "statusOverride": "ended",
              "statusOverrideAt": "2023-11-07T05:31:56Z",
              "statusOverrideBy": "<string>",
              "updatedAt": "2023-11-07T05:31:56Z",
              "updatedBy": "<string>"
            }
          ],
          "updatedAt": "2023-11-07T05:31:56Z",
          "updatedBy": "<string>",
          "waitlist": {
            "archived": true,
            "createdAt": "2023-11-07T05:31:56Z",
            "createdBy": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "capacity": 123,
            "statusOverride": "ended",
            "statusOverrideAt": "2023-11-07T05:31:56Z",
            "statusOverrideBy": "<string>",
            "updatedAt": "2023-11-07T05:31:56Z",
            "updatedBy": "<string>"
          }
        }
      ],
      "theme": {
        "background": "<string>",
        "danger": "<string>",
        "fontFamily": "<string>",
        "fontHeading": "<string>",
        "headerImageUrl": "<string>",
        "logoUrl": "<string>",
        "muted": "<string>",
        "primary": "<string>",
        "secondary": "<string>",
        "success": "<string>",
        "surface": "<string>",
        "text": "<string>",
        "warning": "<string>"
      },
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>"
    }
  ],
  "pageInfo": {
    "endCursor": "<string>",
    "startCursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Fanfare secret key. Keep secret credentials on your server.

Response

Experiences retrieved successfully

data
object[]
required
pageInfo
object
required