Query Customers
GET
/
Query customers
https://api.fortellis.io/cdkdrive/crm/v1/customers
/
Resource Details
|
Security |
|---|
Request
Path Parameters
| Parameter | Type | Description | Required |
|---|
Query Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| name | string | Filters customers by name | No |
| string | Filters customers by email address | No | |
| phone | string | Filters customers by phone number | No |
| postalCode | string | Filters customers by postal code | No |
Header Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| Subscription-Id | string | The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'. | Yes |
| Authorization | string | Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret. | Yes |
Request Body Structure
Request Body Example
Response
Response Body Structure
Response Body Example
Response Error Details
| HTTP Code | Description |
|---|---|
| 400 | 400 - Bad Request |
| 401 | 401 - Unauthorized |
| 403 | 403 - Forbidden |
Try It Out
-
name
(string) Filters customers by name
-
email
(string) Filters customers by email address
-
phone
(string) Filters customers by phone number
-
postalCode
(string) Filters customers by postal code
-
Subscription-Id
(required)(string) The Fortellis Marketplace subscription identifier between a user entity and the solution. For sample responses use the Subscription-Id 'test'.
-
Authorization
(required)(string) Provide authorization to access Fortellis APIs. This must be an OAuth 2.0 token for calling a Fortellis Provider but you may call the simulator platform with basic auth using your API key and secret.
Working...
x