List Customers

Retrieve customers data from Xorosoft ERP using the supported query filters. Use this endpoint to synchronize reference or transaction data with external systems while respecting private app permissions.

get

Authorizations

AuthorizationstringRequired

Query parameters

idstringOptional

Comma-separated Xorosoft ERP record identifier(s).

emailstringOptional

Email address used to find matching customer or contact records.

phonestringOptional

Phone number used to find matching customer or contact records.

customer_numberstringOptional

Customer number assigned in Xorosoft ERP.

created_at_minstringOptional

Filter records created on or after this date.

updated_at_minstringOptional

Filter records updated on or after this date.

created_at_maxstringOptional

Filter records created on or before this date.

updated_at_maxstringOptional

Filter records updated on or before this date.

customer_namestringOptional

Customer name to search or match when a customer identifier is not supplied.

account_nostringOptional

Customer account number.

since_idstringOptional

Return records with an identifier greater than this value.

tagsstringOptional

Comma-separated tags used to filter matching records.

page_sizestringOptional

Number of records to return per page.

Default: 100

page_numberstringOptional

Page number for paginated responses.

Default: 1

contact_emailstringOptional

Contact email address used to filter customer records.

customer_group_namestringOptional

Customer group name used to filter customer records.

querystringOptional

Search text used by the endpoint where supported.

Responses

200

Request processed successfully.

application/json

Standard Xorosoft ERP API response envelope used by most endpoints.

ResultbooleanOptional

True when the operation completed successfully.

MessagestringOptional

Human-readable success or error message.

Pageinteger · nullableOptional

Current page number when paging is enabled.

TotalPagesinteger · nullableOptional

Total page count when paging is enabled.

400

Invalid request, failed validation, or business rule error.

text/plain

401

Missing or invalid private app credentials.

403

Private app does not have permission for this request.

get/api/xerp/customers/getcustomer

GET /api/xerp/customers/getcustomer HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Accept: */*

{
  "Result": true,
  "Message": "Request processed successfully",
  "Data": {}
}