List customers

Retrieve all invoices created with the current administration, ordered from newest to oldest.The results are paginated. See pagination for more information.

List customers

GET https://api.notify.cm/v2/customers

Authentication: API keys

Query Parameters

Name	Type	Description
Limit	number	The number of customers to return (with a maximum of 250).
From	string	Used for pagination. Offset the result set to the invoice with this ID. The invoice with this ID is included in the result as well.

Headers

Name	Type	Description
Authorization	string	Your test or live API key

200

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
   "customers": [
        {
            "resource": "customer",
            "customerCode": "a0f0660d-6c8d-422b-8114-e363b260521e",
            "number":"10001",
            "name":"Creditpartners B.V.",
            "address": {
                "address":"Canadalaan 4",
                "postalcode":"7316 BX",
                "city":"Apeldoorn",
                "country":"NL",
             },
             "contact":"Jan Post",
             "phone":"0882441100",
             "mobile":"0612345678",
             "email":"[e-mail]",
             "invoiceEmail":"[e-mail]",
             "registrationNumber":"123456",
             "language":"dutch"
        },
        {},
        {},
        {},
        {}
   ],
   "count": 5,
   "links": {
        "previous": null,
        "next": {
            "href": "https://api.notify.cm/v2/customers?from=a0f0660d-6c8d-422b-8114-e363b260521e&limit=5",
            "type": "application/hal+json"
        }
   }
}

Example

curl -X GET https://api.notify.cm/v2/customers \
   -H "Authorization: Bearer test_R7HQ9QpXgx8J32rW9X9UyXjgfNk6C7TQ2UD8M5rwf8vVnYxnSETvSuEC6SKFW8Ug" \

Example with limit and from set.

curl -X GET https://api.notify.cm/v2/customers?limit=100&from=a0f0660d-6c8d-422b-8114-e363b260521e \
   -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" \

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
   "customers": [
        {
            "resource": "customer",
            "id": "a0f0660d-6c8d-422b-8114-e363b260521e",
            "customerCode":"10001",
            "name":"Creditpartners B.V.",
            "address": {
                "address":"Canadalaan 4",
                "postalcode":"7316 BX",
                "city":"Apeldoorn",
                "country":"NL"
             },
             "contact":"Jan Post",
             "phone":"0882441100",
             "mobile":"0612345678",
             "email":"[e-mail]",
             "invoiceEmail":"[e-mail]",
             "registrationNumber":"123456",
             "language":"dutch"
        },
        {},
        {},
        {},
        {}
   ],
   "count": 5,
   "links": {
        "previous": null,
        "next": {
            "href": "https://api.notify.cm/v2/customers?from=a0f0660d-6c8d-422b-8114-e363b260521e&limit=250",
            "type": "application/hal+json"
        }
   }
}