GET
/
v1
/
customers
curl --request GET \
  --url https://api.nomod.com/v1/customers \
  --header 'X-API-KEY: <api-key>'
[
  {
    "count": 123,
    "next": "<string>",
    "previous": "<string>",
    "results": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created": "2023-11-07T05:31:56Z",
        "first_name": "<string>",
        "last_name": "<string>",
        "business_name": "<string>",
        "job_title": "<string>",
        "province": 123,
        "city": "<string>",
        "street": "<string>",
        "zip_code": "<string>",
        "country": "<string>",
        "email": "[email protected]",
        "phone_number": "<string>"
      }
    ]
  }
]

Authorizations

​
X-API-KEY
string
header
required

Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings

Query Parameters

​
business_name
string
​
email
string
​
first_name
string
​
id
string
​
last_name
string
​
page
integer

Page number

​
page_size
integer

Number of results per page

​
search
string

Search for first name, last name, email

Response

200 - application/json

Paginated list of contacts with metadata

The response is of type object[].