GET Customers?offset={offset}&limit={limit}&PersonalId={PersonalId}&FirstName={FirstName}&LastName={LastName}&IsActive={IsActive}

Get a list of customers and related information. Sorted by LastName, FirstName, CustomerId

Request Information

URI Parameters

Name	Description	Type	Additional information
offset	Result record start offset. Default 1. RFC 5988 recommended	integer	Default value is 1
limit	Result maximum quantity of records. Default 500	integer	Default value is 500
PersonalId	Customer Personal ID [MaxLength(30)]	string	None.
FirstName	First Name [MaxLength(50)]	string	None.
LastName	Last Name [MaxLength(50)]	string	None.
IsActive	Is Active	boolean	None.

Body Parameters

None.

Response Information

Resource Description

Paged result set of useful customer record fields. Excludes custom properties

CustomerPagedResult

Name	Description	Type	Additional information
start	Starting record index. 1 based.	integer	None.
count	Number of rows in this page of the result set	integer	None.
totalCount	Total number of rows in the result set	integer	None.
totalPages	Total page count for the requested number of records: totalCount/limit-offset	integer	None.
customerResults	Customer Query results set	Collection of CustomerList	None.

Response Formats

application/json, text/json

Sample:

{
  "start": 1,
  "count": 2,
  "totalCount": 3,
  "totalPages": 4,
  "customerResults": [
    {
      "RowNum": 1,
      "CustomerId": 2,
      "PersonalId": "sample string 3",
      "PersonalIdTypeId": 4,
      "PersonalIdTypeExtRef": "sample string 5",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "Email": "sample string 8",
      "TelNumber1": "sample string 9",
      "TelNumber2": "sample string 10",
      "DOB": "2025-09-13T08:28:20.1050027+10:00",
      "Sex": 64,
      "Notes": "sample string 13",
      "ExtRef": "sample string 14",
      "IsActive": true,
      "CustomProperties": "sample string 16"
    },
    {
      "RowNum": 1,
      "CustomerId": 2,
      "PersonalId": "sample string 3",
      "PersonalIdTypeId": 4,
      "PersonalIdTypeExtRef": "sample string 5",
      "FirstName": "sample string 6",
      "LastName": "sample string 7",
      "Email": "sample string 8",
      "TelNumber1": "sample string 9",
      "TelNumber2": "sample string 10",
      "DOB": "2025-09-13T08:28:20.1050027+10:00",
      "Sex": 64,
      "Notes": "sample string 13",
      "ExtRef": "sample string 14",
      "IsActive": true,
      "CustomProperties": "sample string 16"
    }
  ]
}