List customers

GET 
/v1/customers

This endpoint allows you to retrieve a list of customers.

Request

Query Parameters

search string
Any text supplied here would be used to search for customers in any of the following fields
• customer email
• customer name
• customer phone
• customer ref
page integer

Default value: 1

The page of results

per_page integer

Default value: 15

Maximum Number of results per page

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
ref stringrequired
Unique identifier for the customer on your system
email stringrequired
The customer's email address
phone string
first_name stringrequired
last_name stringrequired
]
links object
first string
last string
prev string
next string

Example (from schema)

{
  "data": [
    {
      "ref": "string",
      "email": "string",
      "phone": "408-867-5309",
      "first_name": "Jane",
      "last_name": "Doe"
    }
  ],
  "links": {
    "first": "https://api.grow.curacel.co/customers?page=1",
    "last": "https://api.grow.curacel.co/customers?page=3",
    "prev": "https://api.grow.curacel.co/customers?page=1",
    "next": "https://api.grow.curacel.co/customers?page=2"
  }
}

400

Bad request.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "400 Bad Request (Client Error)"
}

Loading...