Retrieves a list of all customers. Supports pagination and filtering by companyId.
Final POS API (1.2.4)
Welcome to the Final POS Public API—your playground for crafting the checkout and kiosk flows you want. Create your API keys in Manage (Settings > API Keys) and send them as x-api-key on every request. Customer endpoints use dynamic DTO generation so they adapt to your custom tables in real time, while the rest of the controllers follow a stable, static contract for predictable integrations.
Download OpenAPI description
Overview
License
Languages
Servers
Mock server
https://docs.finalpos.com/_mock/openapi
Official API
https://api.finalpos.com
- Mock serverhttps://docs.finalpos.com/_mock/openapi/v1/api/customers
- Official APIhttps://api.finalpos.com/v1/api/customers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.finalpos.com/_mock/openapi/v1/api/customers?skip=0&limit=0' \
-H 'x-api-key: YOUR_API_KEY_HERE'Successfully retrieved a list of customers
Timestamp when the Customer was created.
Example: "2025-12-07T19:31:48.436+00:00"
Timestamp when the Customer was last updated.
Example: "2025-12-07T19:35:48.436+00:00"
External ID associated with the Customer when synced from external source. If present, it will set fromFinal to true.
Example: "o1p2q3r4s5t6u7v8w9x0y1z2"
Timestamp when the Customer was last actioned.
Example: "2025-12-07T19:31:48.436+00:00"
Billing address associated with the Customer.
Example: {"firstName":"John","lastName":"Doe","address1":"123 Main St","address2":"Suite 100","city":"New York","state":"NY","country":"USA","postCode":"10001"}
Shipping address associated with the Customer.
Example: {"firstName":"John","lastName":"Doe","address1":"123 Main St","address2":"Suite 100","city":"New York","state":"NY","country":"USA","postCode":"10001"}
Metadata associated with the Customer.
Example: [{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}]
Notes associated with the Customer.
Example: [{"createdAt":"2025-12-07T19:31:48.436+00:00","message":"Note 1"}]
Response
application/json
[ { "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", "fromFinal": false, "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2", "externalId": "o1p2q3r4s5t6u7v8w9x0y1z2", "phone": "+1234567890", "totalSpent": "1000.50", "lastAction": "2025-12-07T19:31:48.436+00:00", "tags": [ … ], "billing": { … }, "shipping": { … }, "metadata": [ … ], "notes": [ … ] } ]