GET
/
Resource Details
|
Security |
|---|
Request
Path Parameters
| Parameter | Type | Description | Required |
|---|
Query Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| firstName | string | Filters customers by first name | No |
| lastName | string | Filters customers by last 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 |
| page | number | A non-zero integer representing the page of the results | No |
| pageSize | number | A non-negative, non-zero integer indicating the maximum number of results to return at one time | No |
Header Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| Accept | string | n/a | No |
| Accept-Charset | string | n/a | No |
| Accept-Language | string | n/a | No |
| If-Match | string | Specifies a conditional request to only return the resource when it does match one of the included ETag values | No |
| If-None-Match | string | Specifies a conditional request to only return the resource when it doesn't match one of the included ETag values | No |
| Prefer | string | n/a | No |
| Request-Id | string | n/a | No |
| 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 |
| 404 | 404 - Not Found |
Try It Out
-
firstName
(string) Filters customers by first name
-
lastName
(string) Filters customers by last name
-
email
(string) Filters customers by email address
-
phone
(string) Filters customers by phone number
-
postalCode
(string) Filters customers by postal code
-
page
(number) A non-zero integer representing the page of the results
-
pageSize
(number) A non-negative, non-zero integer indicating the maximum number of results to return at one time
-
Accept
(string)
-
Accept-Charset
(string)
-
Accept-Language
(string)
-
If-Match
(string) Specifies a conditional request to only return the resource when it does match one of the included ETag values
-
If-None-Match
(string) Specifies a conditional request to only return the resource when it doesn't match one of the included ETag values
-
Prefer
(string)
-
Request-Id
(string)
-
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...