Skip to content
Veeqo, An Amazon company Developers
Login Signup

List All Customers

GET
/customers

Parameters

Query Parameters

page_size
integer
default: 12

Amount of results

Example
25
page
integer
default: 1

Page to show

Example
1
query
string

Free text search

Example
joebloggs@example.com

Header Parameters

x-api-key
string

E.g. 123

Example
123

Responses

200

OK

object
id
number
email
string
phone
string
mobile
string
notes
string
created_by_id
number
billing_address
object
id
number
first_name
string
last_name
string
company
string
address1
string
address2
string
city
string
country
string
state
nullable
zip
string
phone
nullable
email
nullable
shipping_addresses
Array<object>
object
id
number
first_name
string
last_name
string
company
string
address1
string
address2
string
city
string
country
string
state
string
zip
string
phone
string
last_used_shipping_address
object
id
number
first_name
string
last_name
string
company
string
address1
string
address2
string
city
string
country
string
state
string
zip
string
phone
string
Example
{
  "id": 123,
  "email": "Phil+API@veeqo.com",
  "phone": "01792 720740",
  "mobile": "07329023903",
  "notes": "This person buys things",
  "created_by_id": 12005,
  "billing_address": {
    "id": 12345678,
    "first_name": "Phil",
    "last_name": "Reynolds",
    "company": "Veeqo Ltd",
    "address1": "Tech Hub",
    "address2": "221 High Street",
    "city": "Swansea",
    "country": "GB",
    "state": null,
    "zip": "SA1 1NW",
    "phone": null,
    "email": null
  },
  "shipping_addresses": [
    {
      "id": 12345678,
      "first_name": "Phil",
      "last_name": "Reynolds",
      "company": "Veeqo Ltd",
      "address1": "Tech Hub",
      "address2": "221 High Street",
      "city": "Swansea",
      "country": "GB",
      "state": "",
      "zip": "SA1 1NW",
      "phone": ""
    }
  ],
  "last_used_shipping_address": {
    "id": 12345678,
    "first_name": "Phil",
    "last_name": "Reynolds",
    "company": "Veeqo Ltd",
    "address1": "Tech Hub",
    "address2": "221 High Street",
    "city": "Swansea",
    "country": "GB",
    "state": "",
    "zip": "SA1 1NW",
    "phone": ""
  }
}

Headers

Transfer-Encoding
string
X-Total-Count
string
X-Total-Pages-Count
string
X-Page-Index
string
X-Per-Page
string
X-Runtime
string