Get Customers

GET/company/{id}/customers

Path Parameters

id*string

The company ID

Length1 <= length

Query Parameters

name?string

type?string

Value in

"Individual"
"Business"
"Unknown"

status?string

Value in

"Active"
"Inactive"
"Unknown"

count?integer

after?string

Response Body

`application/json`

curl -X GET "https://example.com/company/string/customers"

{  "items": [    {      "id": "string",      "name": "string",      "email": "string",      "phoneNumber": "string",      "billingAddressJson": {        "zip": "string",        "city": "string",        "addressLine1": "string",        "addressLine2": "string",        "state": "",        "country": ""      },      "companyName": "string",      "contactName": "string",      "description": "string",      "website": "string",      "status": "Active",      "type": "Individual"    }  ],  "pageInfo": {    "endCursor": "string",    "hasNextPage": true,    "total": 0  }}

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Path Parameters

Query Parameters

Response Body

`application/json`