> ## Documentation Index > Fetch the complete documentation index at: https://docs.fanfare.io/llms.txt > Use this file to discover all available pages before exploring further. # GET /sequences/{sequenceId} > Get a sequence ## OpenAPI ````yaml /api/openapi/admin-api.json get /sequences/{sequenceId} openapi: 3.1.0 info: description: Admin API for Fanfare title: Fanfare Admin API version: 1.0.0 servers: - description: Production url: https://admin.fanfare.io/api - description: Local development url: http://localhost:4800 security: - SecretKeyAuth: [] paths: /sequences/{sequenceId}: get: tags: - Distributions description: Get a sequence operationId: getSequencesBySequenceId parameters: - in: path name: sequenceId required: true schema: type: string responses: '200': content: application/json: schema: $defs: '3': anyOf: - type: string - type: number - type: boolean - type: 'null' - items: anyOf: - type: string - type: number - type: integer - type: boolean - type: 'null' - items: {} type: array - additionalProperties: {} type: object type: array - additionalProperties: anyOf: - type: string - type: number - type: integer - type: boolean - type: 'null' - items: {} type: array - additionalProperties: {} type: object propertyNames: type: string type: object properties: accessCode: anyOf: - type: string - type: 'null' announcements: anyOf: - items: properties: anchorPoint: anyOf: - enum: - DISTRIBUTION_OPEN - DISTRIBUTION_CLOSE - DRAW_TIME - AUCTION_SETTLE - EXPERIENCE_START - EXPERIENCE_END - type: 'null' archived: type: boolean content: minLength: 1 type: string createdAt: format: date-time type: string createdBy: type: string creativeDesignId: anyOf: - format: uuid type: string - type: 'null' creativeDocument: anyOf: - properties: body: additionalProperties: anyOf: - type: string - type: number - type: integer - type: boolean - type: 'null' - items: {} type: array - additionalProperties: {} type: object propertyNames: type: string type: object editor: minLength: 1 type: string kind: enum: - announcement-email - announcement-sms - announcement-social - experience-page - transactional-email - transactional-sms schemaVersion: minimum: 1 type: integer themeOverrides: properties: background: type: string danger: type: string fontFamily: type: string fontHeading: type: string headerImageUrl: format: uri type: string logoUrl: format: uri type: string muted: type: string primary: type: string secondary: type: string success: type: string surface: type: string text: type: string variant: enum: - default - retro - rounded - clean warning: type: string required: [] type: object required: - schemaVersion - kind - editor - body type: object - type: 'null' creativeTemplateKey: anyOf: - type: string - type: 'null' experienceId: format: uuid type: string id: format: uuid type: string imageUrl: anyOf: - format: uri type: string - type: 'null' includeAudience: type: boolean includeWaitlist: type: boolean link: anyOf: - format: uri type: string - type: 'null' metadata: anyOf: - properties: email: properties: fromEmail: format: email type: string fromName: type: string replyToEmail: format: email type: string replyToName: type: string required: - fromEmail - replyToEmail type: object required: [] type: object - type: 'null' offsetSeconds: anyOf: - type: number - type: 'null' organizationId: format: uuid type: string scheduledAt: anyOf: - format: date-time type: string - type: 'null' sequenceId: anyOf: - format: uuid type: string - type: 'null' shortContent: anyOf: - type: string - type: 'null' templateData: anyOf: - additionalProperties: anyOf: - type: string - type: number - type: integer - type: boolean - type: 'null' - items: {} type: array - additionalProperties: {} type: object propertyNames: type: string type: object - type: 'null' timeZone: minLength: 1 type: string timingStrategy: default: POINT_IN_TIME enum: - POINT_IN_TIME - RELATIVE title: minLength: 1 type: string type: enum: - EMAIL - SMS - FACEBOOK - X - INSTAGRAM - LINKEDIN - TIKTOK - YOUTUBE updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - type - content - title - includeAudience - includeWaitlist - experienceId - timeZone type: object type: array - type: 'null' appointments: anyOf: - items: properties: archived: type: boolean bufferMinutes: anyOf: - type: number - type: 'null' cleanupStatus: anyOf: - enum: - pending - completed - type: 'null' closeAt: anyOf: - format: date-time type: string - type: 'null' createdAt: format: date-time type: string createdBy: type: string id: format: uuid type: string locationId: anyOf: - format: uuid type: string - type: 'null' maxCapacityPerSlot: anyOf: - type: number - type: 'null' name: minLength: 1 type: string openAt: anyOf: - format: date-time type: string - type: 'null' organizationId: format: uuid type: string sequenceId: format: uuid type: string slotDurationMinutes: anyOf: - type: number - type: 'null' statusOverride: anyOf: - enum: - ended - type: 'null' statusOverrideAt: anyOf: - format: date-time type: string - type: 'null' statusOverrideBy: anyOf: - type: string - type: 'null' timeZone: minLength: 1 type: string updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - sequenceId - name - timeZone type: object type: array - type: 'null' archived: type: boolean auctions: anyOf: - items: properties: archived: type: boolean auctionType: default: english enum: - english - dutch autoExtendSeconds: anyOf: - type: number - type: 'null' cleanupStatus: anyOf: - enum: - pending - completed - type: 'null' closeAt: anyOf: - format: date-time type: string - type: 'null' createdAt: format: date-time type: string createdBy: type: string floorPrice: anyOf: - pattern: ^\d{1,12}(\.\d{1,8})?$ type: string - type: 'null' id: format: uuid type: string minBidIncrement: anyOf: - pattern: ^\d{1,12}(\.\d{1,8})?$ type: string - type: 'null' name: minLength: 1 type: string openAt: anyOf: - format: date-time type: string - type: 'null' organizationId: format: uuid type: string priceDropAmount: anyOf: - pattern: ^\d{1,12}(\.\d{1,8})?$ type: string - type: 'null' priceDropIntervalSeconds: anyOf: - type: number - type: 'null' quantity: anyOf: - type: number - type: 'null' reservePrice: anyOf: - pattern: ^\d{1,12}(\.\d{1,8})?$ type: string - type: 'null' sequenceId: format: uuid type: string settleAt: format: date-time type: string startPrice: anyOf: - pattern: ^\d{1,12}(\.\d{1,8})?$ type: string - type: 'null' statusOverride: anyOf: - enum: - ended - type: 'null' statusOverrideAt: anyOf: - format: date-time type: string - type: 'null' statusOverrideBy: anyOf: - type: string - type: 'null' timeZone: minLength: 1 type: string updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - sequenceId - name - timeZone - settleAt type: object type: array - type: 'null' audienceId: anyOf: - format: uuid type: string - type: 'null' color: minLength: 1 type: string createdAt: format: date-time type: string createdBy: type: string draws: anyOf: - items: properties: admissionExpirationSeconds: anyOf: - type: number - type: 'null' archived: type: boolean capacity: anyOf: - type: number - type: 'null' cleanupStatus: anyOf: - enum: - pending - completed - type: 'null' closeAt: anyOf: - format: date-time type: string - type: 'null' continueSelectingUntilCompleted: anyOf: - type: boolean - type: 'null' createdAt: format: date-time type: string createdBy: type: string drawAt: format: date-time type: string id: format: uuid type: string loyaltyBiasEnabled: type: boolean name: minLength: 1 type: string openAt: anyOf: - format: date-time type: string - type: 'null' organizationId: format: uuid type: string sequenceId: format: uuid type: string statusOverride: anyOf: - enum: - ended - type: 'null' statusOverrideAt: anyOf: - format: date-time type: string - type: 'null' statusOverrideBy: anyOf: - type: string - type: 'null' timeZone: minLength: 1 type: string updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' winnerCount: type: number required: - id - organizationId - createdAt - createdBy - archived - sequenceId - name - timeZone - drawAt - winnerCount type: object type: array - type: 'null' experienceId: anyOf: - format: uuid type: string - type: 'null' id: format: uuid type: string name: minLength: 1 type: string organizationId: format: uuid type: string priority: type: number productSelectionMode: anyOf: - enum: - USER_SELECTED - SYSTEM_ASSIGNED - type: 'null' queues: anyOf: - items: properties: admissionExpirationSeconds: anyOf: - type: number - type: 'null' admitRate: type: number archived: type: boolean capacity: anyOf: - type: number - type: 'null' cleanupStatus: anyOf: - enum: - pending - completed - type: 'null' closeAt: anyOf: - format: date-time type: string - type: 'null' createdAt: format: date-time type: string createdBy: type: string id: format: uuid type: string loyaltyBiasEnabled: type: boolean maxAdmissions: anyOf: - type: number - type: 'null' name: minLength: 1 type: string openAt: anyOf: - format: date-time type: string - type: 'null' organizationId: format: uuid type: string sequenceId: format: uuid type: string statusOverride: anyOf: - enum: - ended - type: 'null' statusOverrideAt: anyOf: - format: date-time type: string - type: 'null' statusOverrideBy: anyOf: - type: string - type: 'null' timeZone: minLength: 1 type: string updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - sequenceId - name - timeZone - admitRate type: object type: array - type: 'null' timedReleases: anyOf: - items: properties: archived: type: boolean cleanupStatus: anyOf: - enum: - pending - completed - type: 'null' closeAt: anyOf: - format: date-time type: string - type: 'null' createdAt: format: date-time type: string createdBy: type: string id: format: uuid type: string name: minLength: 1 type: string openAt: anyOf: - format: date-time type: string - type: 'null' organizationId: format: uuid type: string sequenceId: format: uuid type: string statusOverride: anyOf: - enum: - ended - type: 'null' statusOverrideAt: anyOf: - format: date-time type: string - type: 'null' statusOverrideBy: anyOf: - type: string - type: 'null' supportsGuest: type: boolean timeZone: minLength: 1 type: string updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - sequenceId - name - timeZone - supportsGuest type: object type: array - type: 'null' updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' waitlist: anyOf: - properties: archived: type: boolean capacity: anyOf: - type: number - type: 'null' cleanupStatus: anyOf: - enum: - pending - completed - type: 'null' createdAt: format: date-time type: string createdBy: type: string id: format: uuid type: string organizationId: format: uuid type: string sequenceId: format: uuid type: string statusOverride: anyOf: - enum: - ended - type: 'null' statusOverrideAt: anyOf: - format: date-time type: string - type: 'null' statusOverrideBy: anyOf: - type: string - type: 'null' updatedAt: anyOf: - format: date-time type: string - type: 'null' updatedBy: anyOf: - type: string - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - sequenceId type: object - type: 'null' required: - id - organizationId - createdAt - createdBy - archived - name - priority - color type: object description: Sequence retrieved successfully '400': content: application/json: schema: properties: error: const: validation_error issues: items: properties: expected: type: string kind: type: string message: type: string path: items: properties: input: {} key: type: string origin: type: string type: type: string required: - type - origin - input - key type: object type: array received: type: string type: type: string required: - kind - type - expected - received - message - path type: object type: array required: - error - issues type: object description: Bad Request - Invalid input schema '401': content: application/json: schema: properties: error: type: string required: - error type: object description: Unauthorized - Authentication required '403': content: application/json: schema: properties: error: type: string required: - error type: object description: Forbidden - User must be authenticated '500': content: application/json: schema: properties: error: type: string required: - error type: object description: Internal server error components: securitySchemes: SecretKeyAuth: description: Fanfare secret key. Keep secret credentials on your server. scheme: bearer type: http ````