> ## Documentation Index > Fetch the complete documentation index at: https://www.twicecommerce.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get all customers > Lists CRM customers with filtering and pagination. ## OpenAPI ````yaml https://server.twicecommerce.com/api/admin/openapi-mintlify.json get /v1/admin/customers openapi: 3.0.2 info: title: TWICE Admin API description: "The TWICE Admin API is the merchant-facing API of the Twice platform. It is currently in alpha: endpoints and schemas may change without notice.\n\n## Webhooks\n\nWebhooks notify your systems when resources change in Twice. A webhook subscription pairs one event type with one HTTPS endpoint of yours; whenever a matching event occurs, we POST the event to that endpoint. Subscriptions and their delivery logs are managed in the Twice admin under **Account → Integrations**.\n\n### Event types\n\n- `order.created`\n- `order.deleted`\n- `order.updated`\n\n### Payload\n\nEvery delivery is an HTTP POST with a JSON body sharing a common envelope. The typed payload of each event type is documented in the **Webhooks** section of the sidebar.\n\n```json\n{\n\t\"eventId\": \"5f2eb3a6-6cbd-4a2e-9350-6e0d1e2f9a11\",\n\t\"eventType\": \"order.created\",\n\t\"eventTime\": \"2026-08-06T12:34:56.789Z\",\n\t\"resource\": \"order\",\n\t\"resourceId\": \"0d9e0a7c-3fd1-4c8f-9c0d-2b7c6f7f2a55\",\n\t\"apiVersion\": \"2025-06\",\n\t\"data\": { \"…\": \"the API representation of the resource, or null for deletes\" }\n}\n```\n\n`data` carries the resource in the same shape the REST API returns it, as of the API version in `apiVersion`. Each subscription is pinned to the API version that was the latest when the subscription was created, so a new API version never changes the payload shape you receive — moving to a newer version is an explicit update of the subscription.\n\n### Acknowledging deliveries\n\nRespond with any **2xx** status to acknowledge a delivery. Any other status — or a timeout — counts as a failed attempt. Respond as quickly as possible and do heavy processing asynchronously after acknowledging.\n\n### Delivery semantics\n\nDeliveries are **at-least-once**: the same event can occasionally be delivered more than once, so deduplicate on the `X-Twice-Event-Id` header (or the equal `eventId` body field). Ordering is not guaranteed — when it matters, use `eventTime` or re-fetch the current state of the resource via the API.\n\n### Retries\n\nFailed deliveries are retried up to 3 times (4 attempts in total) with growing backoff — roughly 10 s, 20 s, 40 s after the preceding attempt — giving up 10 minutes after the first attempt. After 3 consecutive events fail all their attempts, the subscription is automatically disabled (`disabledReason: TOO_MANY_FAILED_DELIVERY_ATTEMPTS`) and must be re-enabled manually in the admin. Individual deliveries can also be redelivered manually from the delivery log.\n\n### Verifying signatures\n\nEach subscription has a signing secret (prefixed `whsec_`), available in the admin. Deliveries carry an HMAC-SHA256 signature of the exact raw request body in the `X-Twice-Signature` header, formatted `sha256=`. Verify it against the raw body bytes — parse the JSON only after the signature checks out:\n\n```js\nimport { createHmac, timingSafeEqual } from 'node:crypto';\n\nconst expected = 'sha256=' + createHmac('sha256', secret).update(rawBody, 'utf8').digest('hex');\nconst signature = req.headers['x-twice-signature'];\nconst isValid =\n\ttypeof signature === 'string' &&\n\tsignature.length === expected.length &&\n\ttimingSafeEqual(Buffer.from(signature), Buffer.from(expected));\n```" version: 2025-06 servers: - url: https://server.twicecommerce.com security: - ApiKeyAuth: [] paths: /v1/admin/customers: get: tags: - customers summary: Get all customers description: Lists CRM customers with filtering and pagination. operationId: admin.customers.list parameters: - name: filters in: query style: deepObject schema: type: object properties: customerIds: type: array items: type: string search: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value createdAt: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ - anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - operator - value firstName: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value lastName: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value fullName: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value phone: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value email: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value marketingConsent: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: boolean - type: boolean required: - operator - value language: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value customerType: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value companyName: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value taxId: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value dateOfBirth: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ - anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - operator - value billingStreet: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value billingZipCode: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value billingCity: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value billingState: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value billingCountry: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value shippingStreet: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value shippingZipCode: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value shippingCity: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value shippingState: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value shippingCountry: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value attributes: type: object properties: id: type: string operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: anyOf: - type: boolean - type: string - type: number - anyOf: - type: boolean - type: string - type: number format: type: string enum: - text - number - boolean - date - datetime - select - multiselect required: - id - operator - value ids: type: array items: type: string tagIds: type: array items: type: string tags: type: object properties: operator: type: string enum: - startsWith - endsWith - contains - doesNotContain - eq - ne - gt - gte - lt - lte - inArray - notInArray - between - notBetween - isEmpty - isNotEmpty - isToday - isBeforeToday - isAfterToday value: anyOf: - type: array items: type: string - type: string required: - operator - value scope: type: string enum: - active - archived - all - name: orderBy in: query style: deepObject schema: type: object properties: attributeId: type: string field: type: string enum: - tags - billingStreet - billingZipCode - billingCity - billingState - billingCountry - shippingStreet - shippingZipCode - shippingCity - shippingState - shippingCountry - createdAt - firstName - lastName - fullName - email - phone - marketingConsent - language - customerType - companyName - taxId - dateOfBirth direction: type: string enum: - asc - desc - name: pagination in: query style: deepObject schema: type: object properties: size: type: number page: type: number required: - size - page responses: '200': description: '200' content: application/json: schema: type: object properties: data: type: object properties: id: type: string createdAt: type: string updatedAt: type: string firstName: type: string lastName: type: string fullName: type: string email: nullable: true type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ phone: type: string customerType: type: string enum: - individual - business companyName: type: string taxId: type: string dateOfBirth: type: string language: type: string marketingConsent: type: boolean marketingConsentUpdatedAt: type: string billingAddress: type: object properties: address: type: string zipCode: type: string city: type: string country: type: string state: type: string details: type: string deliveryNotes: type: string additionalProperties: false shippingAddress: type: object properties: address: type: string zipCode: type: string city: type: string country: type: string state: type: string details: type: string deliveryNotes: type: string additionalProperties: false status: type: string enum: - active - archived archivedAt: nullable: true type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ attributes: type: object properties: id: type: string name: type: string key: type: string value: nullable: true anyOf: - type: string - type: number - type: boolean - type: array items: type: string format: type: string enum: - text - number - boolean - date - datetime - formula - select - multiselect groupId: nullable: true type: string groupName: nullable: true type: string systemGroup: nullable: true type: string enum: - sustainability - system origin: type: string enum: - article - sku - customer - catalog required: - id - name - key - value - format - groupId - groupName - systemGroup - origin additionalProperties: false documents: type: object properties: fileId: type: string customerId: type: string document: type: object properties: id: type: string tenantId: type: string fileUrl: type: string mimeType: type: string originalName: type: string folderPath: nullable: true type: string size: type: number createdAt: type: string updatedAt: type: string deletedAt: nullable: true type: string updatedById: nullable: true type: string createdById: nullable: true type: string required: - id - tenantId - fileUrl - mimeType - originalName - folderPath - size - createdAt - updatedAt - deletedAt - updatedById - createdById additionalProperties: false orderIndex: type: number comment: nullable: true type: string required: - fileId - customerId - orderIndex - comment additionalProperties: false tags: type: object properties: id: type: string value: type: string scope: type: string enum: - inventory - catalog - customers - orders createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updatedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - id - value - scope - createdAt - updatedAt additionalProperties: false aggregateData: type: object properties: totalCount: type: number lastCreated: nullable: true type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ lastUpdated: nullable: true type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - totalCount - lastCreated - lastUpdated additionalProperties: false required: - id - createdAt - updatedAt - firstName - fullName - email - customerType - marketingConsent - status - aggregateData additionalProperties: false totalCount: type: number required: - data - totalCount additionalProperties: false '400': description: '400' '401': description: '401' '403': description: '403' '404': description: '404' content: application/json: schema: type: object properties: message: type: string required: - message additionalProperties: false '429': description: '429' '500': description: '500' components: securitySchemes: ApiKeyAuth: type: apiKey name: X-API-KEY in: header description: API key for the Twice API ````