Sign in

v1

latestSwagger 2.02026-08-043765135.6 KB
customers

Get Customers

Retrieve all existing customers that were created via this API. Customers created through APIv3 (http://production.brickworksoftware.com/api_docs/) are not included.

get/customers

Query parameters

idstring[]
firstNamestring

Query by resource first name

lastNamestring

Query by resource last name

emailstring

Query by resource email

mockboolean

Return mock data

perPageinteger

Query parameter to set the number of results per page

pageAfterstring

Query parameter to set the token for the next page of results

order'asc' | 'desc'

Specify the order of the returned data based on the field specified in "orderBy".

orderBystring

Field by which to order results

Response

Return an array of data responses

Example response

{
  "data": [
    {
      "attributes": {
        "createdAt": "2018-02-03T10:30:00Z",
        "updatedAt": "2018-02-03T10:30:00Z"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "bdb88373-bf66-4bfc-a4f8-3a35be5c2f9c"
          }
        }
      }
    }
  ]
}