> ## Documentation Index > Fetch the complete documentation index at: https://docs.bizzyco.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get email opt-in > Get a marketing email opt-in record, live or withdrawn. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/email-opt-ins/{id} openapi: 3.1.0 info: title: Bizzy API version: 1.0.0 description: Bizzy API for managing businesses, customers, contacts, and more. servers: - url: https://api.bizzyco.ai description: Production security: [] tags: - name: Automations description: Manage workflow automation rules x-group: Automations - name: Automation Executions description: View automation execution history x-group: Automations - name: Businesses description: Manage business profiles x-group: Businesses - name: Business Offerings description: Manage products and services offered by businesses x-group: Businesses - name: Business Online Presences description: Manage websites and social media links x-group: Businesses - name: Business Physical Presences description: Manage physical locations and addresses x-group: Businesses - name: Business Profile description: View and update business profile details x-group: Businesses - name: Business Properties description: Set and review custom property values on businesses x-group: Businesses - name: Contacts description: Manage contact records x-group: Contacts - name: Contact Addresses description: Manage mailing addresses for contacts x-group: Contacts - name: Contact Emails description: Manage email addresses for contacts x-group: Contacts - name: Contact Phone Numbers description: Manage phone numbers for contacts x-group: Contacts - name: Contact Properties description: Set and review custom property values on contacts x-group: Contacts - name: Customers description: Manage customer records x-group: Customers - name: Customer Transactions description: View customer transaction history x-group: Customers - name: Customer Properties description: Set and review custom property values on customers x-group: Customers - name: Domains description: Manage domain names x-group: Domains - name: Domain Contacts description: Manage contacts associated with domains x-group: Domains - name: Domain Registrations description: Manage domain registration records x-group: Domains - name: Email Templates description: Manage reusable email templates x-group: Email Templates - name: Email Opt-ins description: Record and withdraw recipients' marketing email opt-ins x-group: Email Templates - name: Files description: Manage file uploads and downloads x-group: Files - name: File Access Links description: Manage shareable file access links x-group: Files - name: Folders description: Organize files into folders x-group: Files - name: Messages description: Manage email messages x-group: Messages - name: Message Attachments description: Access message file attachments x-group: Messages - name: Message Contacts description: View contacts associated with messages x-group: Messages - name: Property Definitions description: Manage the custom properties contacts, customers, and businesses can hold x-group: Properties - name: Tasks description: Manage task records x-group: Tasks - name: Task Assignees description: Manage user assignments to tasks x-group: Tasks - name: Task Activity description: View task activity and change history x-group: Tasks paths: /v1/email-opt-ins/{id}: get: tags: - Email Opt-ins summary: Get email opt-in description: Get a marketing email opt-in record, live or withdrawn. operationId: getEmailOptIn parameters: - schema: type: string format: uuid description: Email opt-in UUID example: 123e4567-e89b-12d3-a456-426614174000 required: true description: Email opt-in UUID name: id in: path responses: '200': description: Email opt-in details headers: X-RateLimit-Limit: schema: type: integer description: Maximum burst of requests the tier allows per minute X-RateLimit-Remaining: schema: type: integer description: Requests remaining in the current window after this request X-RateLimit-Reset: schema: type: integer description: Seconds until the allowance is fully replenished content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/EmailOptIn' meta: type: object properties: pagination: type: object properties: total: type: number limit: type: number offset: type: number hasMore: type: boolean required: - limit - offset - hasMore required: - data '400': description: Invalid input content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/ApiError' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ApiError' '429': description: Rate limit exceeded for the account tier (error code RATE_LIMITED) headers: X-RateLimit-Limit: schema: type: integer description: Maximum burst of requests the tier allows per minute X-RateLimit-Remaining: schema: type: integer description: Requests remaining in the current window after this request X-RateLimit-Reset: schema: type: integer description: Seconds until the allowance is fully replenished Retry-After: schema: type: integer description: Seconds to wait before the next request will be accepted content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError' security: - bearerAuth: [] components: schemas: EmailOptIn: type: object properties: id: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time organizationId: type: string format: uuid email: type: string description: The recipient address, lowercased example: jane@example.com basis: type: string enum: - express_consent - confirmed_opt_in description: >- How the recipient agreed: `express_consent` means they said yes to marketing email (a ticked box, a spoken or written yes); `confirmed_opt_in` means they then also confirmed it by email (double opt-in). A purchased, scraped or cold-outreach address qualifies under neither. source: type: string enum: - web_form - checkout - in_person - phone - email - paper_form - other description: >- Where the recipient agreed: `web_form` (a website sign-up form), `checkout` (checkout or booking), `in_person`, `phone` (a phone call), `email` (an email from the recipient), `paper_form`, or `other`. capturedOn: type: string format: date description: >- The date the recipient agreed (YYYY-MM-DD), in their own calendar. It can be long before you record it, but not in the future. evidence: type: string description: >- Where the proof of this opt-in is kept: a form URL, a signed-sheet reference, a booking or order ID. Required, up to 1000 characters. createdByUserId: type: - string - 'null' format: uuid description: >- The user who recorded the opt-in, or null when it was recorded with an API key withdrawnAt: type: - string - 'null' format: date-time description: When the opt-in was withdrawn, or null while it is live withdrawnByUserId: type: - string - 'null' format: uuid description: >- The user who withdrew the opt-in, or null when it is live or was withdrawn with an API key required: - id - createdAt - updatedAt - organizationId - email - basis - source - capturedOn - evidence - createdByUserId - withdrawnAt - withdrawnByUserId ApiError: type: object properties: error: type: object properties: message: type: string code: type: string details: {} required: - message - code required: - error securitySchemes: bearerAuth: type: http scheme: bearer description: API key authentication via Bearer token ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.