Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://api.parceltracer.com/v1/external/customers/ \
  --header 'X-Api-Key: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    [
      {
        "id": 1,
        "name": "John Doe",
        "phone_number": "+1234567890",
        "secondary_phone_number": "",
        "email": "[email protected]",
        "locations": [
          {
            "id": 10,
            "area": {
              "name_en": "Aaiyat",
              "name_ar": "عيات",
              "lat": 34.53534,
              "long": 36.19682,
              "district": "Akkar",
              "maps_link": "http://maps.google.com/maps?q=34.53534,36.19682"
            },
            "directions": ""
          }
        ]
      },
      {
        "id": 2,
        "name": "Jane Smith",
        "phone_number": "+1987654321",
        "secondary_phone_number": "",
        "email": "[email protected]",
        "locations": []
      }
    ]
  ]
}

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
include_locations
boolean
default:false

If true, includes locations data for each customer.

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
phone_number
string
default:""

Filter result by a specific phone number. Given that customer's phone numbers are unique, the result will contain at most a single customer object

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"