Customers

Bulk read customers

Retrieves a list of customers. Supports filtering by fields, sorting, and pagination.

get/v1/customers

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/customers
  • Auth: API key in header x-api-key

Query parameters

skipnumber

Number of records to skip (default: 0)

limitnumber

Maximum number of records to return (default: 100, max: 1000)

sortBy'createdAt' | 'updatedAt' | 'email' | 'firstName' | 'lastName'

Field name to sort results by

sortOrder'asc' | 'desc'

Sort direction (default: asc)

searchByEmailstring

Field name to search by (case-insensitive partial match)

searchByFirstNamestring

Field name to search by (case-insensitive partial match)

searchByLastNamestring

Field name to search by (case-insensitive partial match)

searchByPhonestring

Field name to search by (case-insensitive partial match)

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by createdAt using range operators

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by updatedAt using range operators

outletIdstring

Filter by outletId

sourcestring

Filter by source

tagsstring

Filter by tags. Supports comma-separated values for matching any item in the array

Response

Successfully retrieved list of items

Example response

{
  "data": [
    {
      "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "createdAt": "2025-12-07T19:31:48.436+00:00",
      "updatedAt": "2025-12-07T19:35:48.436+00:00",
      "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "email": "customer@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "externalId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "source": "woo-commerce",
      "phone": "+1234567890",
      "totalSpent": 100050,
      "lastAction": "2025-12-07T19:31:48.436+00:00",
      "tags": [
        "vip",
        "loyal",
        "premium"
      ],
      "metadata": [
        {
          "key": "key1",
          "value": "value1"
        },
        {
          "key": "key2",
          "value": "value2"
        }
      ],
      "notes": [
        {
          "message": "Note 1"
        }
      ]
    }
  ],
  "meta": {
    "count": 1450,
    "limit": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.