Customers

List all customers

Changed on Nov 3, 2026

Returns a list of all customers. Customers are returned by creation date, with the most recently created showing first. By default we will return the 25 most recently created objects, unless otherwise specified using the limit query parameter. You can also specify what parameters are returned by using the filter query parameter, if not specified every parameter within the customer record will be returned.

get/customers

Request

Base URL
https://test-api.acquired.com/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/acquired/apis/acquired-api/docs/customers/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

offsetinteger

The record to start the response on.

limitinteger

A limit on the scope of values returned in the response.

filterstring

Filter the parameters that you want to return within the response.

referencestring

Example:customer_reference_032049324

Filter by the customer reference

Headers

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Response

Example response

{
  "meta": {
    "links": [
      {
        "rel": "first",
        "href": "/v1/path?offset=0",
        "title": "first page"
      }
    ]
  },
  "data": [
    {
      "reference": "customer_number_00001",
      "first_name": "Edward",
      "last_name": "Johnson",
      "dob": "1988-10-03",
      "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh",
      "billing": {
        "address": {
          "line_1": "152 Aldgate Drive",
          "city": "London",
          "postcode": "E1 7RT",
          "country_code": "GB"
        },
        "email": "ejohnson@acquired.com",
        "phone": {
          "country_code": "44",
          "number": "2039826580"
        }
      },
      "shipping": {
        "first_name": "Edward",
        "last_name": "Johnson",
        "address": {
          "line_1": "152 Aldgate Drive",
          "city": "London",
          "postcode": "E1 7RT",
          "country_code": "GB"
        },
        "email": "ejohnson@acquired.com",
        "phone": {
          "country_code": "44",
          "number": "2039826580"
        }
      }
    }
  ]
}

Changes

Nov 3, 20269c9e8ec96e98 Revision changes
- info
  added the optional property /////// to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  the /////// response's property pattern was changed from \w+([-+.]\w*)*@ to ^\w+([-+.]\w*)*@\w+([-+.]\w+)*\.\w+([-+.]\w+)*$ for the status
- info
  the /////// response's property pattern was changed from \w+([-+.]\w*)*@ to ^\w+([-+.]\w*)*@\w+([-+.]\w+)*\.\w+([-+.]\w+)*$ for the status

Operation history