Skip to main content
GET
/
v1
/
customers
List Customers
curl --request GET \
  --url https://api.ecrypt.com/v1/customers \
  --header 'x-api-key: <api-key>'
{
  "requestId": "000000000000000000000",
  "customers": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "firstName": "John",
      "lastName": "Doe",
      "company": "US Oil Supply",
      "merchantIdentifier": "EID-987654-321",
      "phoneNumber": "555-555-555",
      "emailAddress": "email@email.com",
      "shippingAddress": {
        "name": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
      },
      "metadata": {}
    }
  ],
  "errors": [
    {
      "type": "<string>",
      "message": "<unknown>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Authorization by x-api-key inside request's header

Query Parameters

Page
integer<int32>

Page of results being requested.

Default: 1

Required range: 1 <= x <= 2147483647
Example:

1

Size
integer<int32>

Size of the page of results being requested.

Default: 100

Required range: 1 <= x <= 100
Example:

100

Response

object | null

OK

requestId
string
default:000000000000000000000
required
Required string length: 1 - 100
customers
(object | null)[] | null
errors
(object | null)[] | null