> ## Documentation Index > Fetch the complete documentation index at: https://docs.eat-now.io/llms.txt > Use this file to discover all available pages before exploring further. # List customers > Returns the restaurant's customers in `updated_at` then `id` order, with cursor pagination. Built for incremental sync: store the `updated_at` of the last customer you processed and pass it back as `updated_since` next time, following `pagination.next_cursor` until `has_more` is false. `updated_since` is inclusive, so the boundary customer comes back once: deduplicate on `id`. Changes to `stats` do not move `updated_at`. Requires `CUSTOMERS_READ`. ## OpenAPI ````yaml https://app.eat-now.io/api/partner/v1/openapi.json get /api/partner/v1/customers openapi: 3.0.3 info: title: EatNow Partner API version: v1 description: >- Version 1 of the EatNow partner API. This API is designed for trusted partner integrations that need restaurant-scoped access to availability, reservation management, and operational reference data. Authentication - Use `Authorization: Bearer ` with a partner API token created from the EatNow dashboard. - Access is controlled by credential scopes and each request is resolved to a single restaurant. Base URL - The server URL in this document is the canonical base URL for the current environment. Errors - Endpoint errors use `error.code`, `error.message`, and `error.request_id`. Errors raised before the endpoint, including rate limiting, may use another format. - Validation, authentication, authorization, conflicts, and not-found cases all use the same top-level error shape. Rate limits - The partner route rule allows 600 requests per minute per client IP. Back off on 429. When present, x-ratelimit-reset is an epoch timestamp in milliseconds. Public endpoints - `GET /api/partner/v1` and `GET /api/partner/v1/openapi.json` are public. - All business endpoints require Bearer authentication. servers: - url: https://app.eat-now.io security: [] tags: - name: Meta description: Platform metadata and schema endpoints - name: Authentication description: Credential validation and auth context endpoints - name: Availability description: Bookable slot search and exact slot validation - name: Catalog description: Reference data for restaurant tables, rooms, prescribers, and discounts - name: Reservations description: Reservation lookup, search, update, and cancellation - name: Customers description: >- Customer (CRM) records, independent of reservations: list, sync, create, update - name: Webhooks description: Webhook endpoints a key subscribes to V1 events (reservations, customers) - name: Missed Calls description: Report missed calls and trigger WhatsApp follow-up templates externalDocs: description: Integration guides, authentication, errors, and webhook reference url: https://docs.eat-now.io/api-reference/introduction paths: /api/partner/v1/customers: get: tags: - Customers summary: List customers description: >- Returns the restaurant's customers in `updated_at` then `id` order, with cursor pagination. Built for incremental sync: store the `updated_at` of the last customer you processed and pass it back as `updated_since` next time, following `pagination.next_cursor` until `has_more` is false. `updated_since` is inclusive, so the boundary customer comes back once: deduplicate on `id`. Changes to `stats` do not move `updated_at`. Requires `CUSTOMERS_READ`. operationId: listPartnerCustomers parameters: - schema: type: string format: date-time description: >- Only customers created or modified at or after this instant. Combine with `cursor` for an incremental sync. required: false description: >- Only customers created or modified at or after this instant. Combine with `cursor` for an incremental sync. name: updated_since in: query - schema: type: string format: email description: Filter by email address (case-insensitive exact match). required: false description: Filter by email address (case-insensitive exact match). name: email in: query - schema: type: string minLength: 1 description: >- Filter by phone number. National and international spellings of the same number match. required: false description: >- Filter by phone number. National and international spellings of the same number match. name: phone in: query - schema: type: string minLength: 1 description: Filter by the partner-side identifier. required: false description: Filter by the partner-side identifier. name: external_id in: query - schema: type: string minLength: 1 description: Only customers carrying this tag (exact match). required: false description: Only customers carrying this tag (exact match). name: tag in: query - schema: type: string minLength: 1 description: '`pagination.next_cursor` of the previous page.' required: false description: '`pagination.next_cursor` of the previous page.' name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: Number of customers per page, from 1 to 100. required: false description: Number of customers per page, from 1 to 100. name: limit in: query responses: '200': description: One page of customers content: application/json: schema: $ref: '#/components/schemas/PartnerApiCustomerListResponse' examples: default: summary: A page with more to follow value: data: - id: cus_123 external_id: crm-4821 name: Jane Doe email: jane@example.com phone_number: '+33612345678' country_code: FR lang: FR tags: - VIP note: Prefers the terrace custom_fields: field_birthday: name: Birthday value: '1990-04-12' newsletter_consent: true marketing_opt_outs: [] blacklisted: false stats: reservation_count: 7 confirmed_count: 6 no_show_count: 1 feedback_count: 2 average_feedback_score: 4.5 total_amount_paid: 42000 average_basket: 2800 last_reservation_date: '2026-09-12' created_at: '2025-11-03T18:22:10.000Z' updated_at: '2026-09-12T21:04:55.000Z' pagination: next_cursor: WyIyMDI2LTA5LTEyVDIxOjA0OjU1LjAwMFoiLCJjdXNfMTIzIl0 has_more: true '400': description: Request validation failed (see `error.details.issues`). content: application/json: schema: $ref: '#/components/schemas/PartnerApiError' '401': description: Authentication failed content: application/json: schema: $ref: '#/components/schemas/PartnerApiError' '403': description: 'Scope is insufficient. Required: `CUSTOMERS_READ`.' content: application/json: schema: $ref: '#/components/schemas/PartnerApiError' '429': description: >- Rate limit exceeded. Configured limit: 600 requests per minute per client IP for the partner route rule. This middleware response may not use the PartnerApiError envelope or include request_id. Back off before retrying. '500': description: >- Unexpected server error. Preserve error.request_id for support. Before retrying a write, check whether it already succeeded. content: application/json: schema: $ref: '#/components/schemas/PartnerApiError' security: - PartnerBearerToken: [] components: schemas: PartnerApiCustomerListResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/PartnerApiCustomerDetail' pagination: $ref: '#/components/schemas/PartnerApiCursorPagination' required: - data - pagination PartnerApiError: type: object properties: error: type: object properties: code: $ref: '#/components/schemas/PartnerApiErrorCode' message: type: string request_id: type: string details: type: object additionalProperties: nullable: true required: - code - message - request_id required: - error PartnerApiCustomerDetail: type: object properties: id: type: string external_id: type: string nullable: true description: >- Partner-side identifier of the customer. Matched first when creating a customer. name: type: string email: type: string nullable: true format: email phone_number: type: string nullable: true description: >- Phone number as stored, spaces removed. E.164 when it was provided that way. country_code: type: string nullable: true lang: type: string enum: - FR - EN - IT - ES - DE - PT tags: type: array items: type: string note: type: string nullable: true description: Internal staff note. custom_fields: type: object additionalProperties: $ref: '#/components/schemas/PartnerApiMetadataField' description: >- Values of the restaurant's customer custom fields, keyed by field id (see `GET /api/partner/v1/customer-fields`). newsletter_consent: type: boolean marketing_opt_outs: type: array items: type: string enum: - EMAIL - WHATSAPP description: >- Channels on which the customer must not receive marketing (unsubscribed, bounced, blocked). blacklisted: type: boolean description: >- Blacklisted by the restaurant: new reservations for this customer are rejected. stats: $ref: '#/components/schemas/PartnerApiCustomerStats' created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - external_id - name - email - phone_number - country_code - lang - tags - note - custom_fields - newsletter_consent - marketing_opt_outs - blacklisted - stats - created_at - updated_at PartnerApiCursorPagination: type: object properties: next_cursor: type: string nullable: true description: >- Opaque cursor to pass as `cursor` to get the next page. Null on the last page. has_more: type: boolean required: - next_cursor - has_more PartnerApiErrorCode: type: string enum: - AUTHENTICATION_REQUIRED - INVALID_AUTHENTICATION - INSUFFICIENT_SCOPE - RESTAURANT_SUSPENDED - VALIDATION_ERROR - RESOURCE_NOT_FOUND - RESOURCE_CONFLICT - RATE_LIMITED - INTERNAL_ERROR PartnerApiMetadataField: type: object properties: name: type: string value: anyOf: - type: string - type: number - type: boolean - nullable: true - type: array items: type: string required: - name - value PartnerApiCustomerStats: type: object properties: reservation_count: type: integer description: >- Reservations that are neither canceled nor rejected, upcoming ones and no-shows included. confirmed_count: type: integer description: '`reservation_count` minus the no-shows.' no_show_count: type: integer feedback_count: type: integer average_feedback_score: type: number nullable: true total_amount_paid: type: integer description: >- Total paid over the customer's reservations, in the smallest currency unit (for example cents). average_basket: type: number description: >- `total_amount_paid` divided by the covers of those reservations, in the smallest currency unit. last_reservation_date: type: string nullable: true description: >- Day (`YYYY-MM-DD`, restaurant calendar) of the latest reservation that is neither canceled nor rejected. Can be in the future. required: - reservation_count - confirmed_count - no_show_count - feedback_count - average_feedback_score - total_amount_paid - average_basket - last_reservation_date description: >- Figures computed by EatNow from the customer's reservations. Read-only. Their changes do not move `updated_at`. securitySchemes: PartnerBearerToken: type: http scheme: bearer bearerFormat: API Token description: >- Restaurant-scoped partner API token passed as `Authorization: Bearer `. x-default: your_token_here ````