get
/
Resource Details
|
Security |
|
|---|---|
|
Content Type |
application/json |
|
Category |
Leads |
Request
Path Parameters
| Parameter | Type | Description | Required |
|---|
Query Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| dateRange.startDate | string | A date in ISO 8601 format indicating the start date of the filter's date range. | No |
| dateRange.endDate | string | A date in ISO 8601 format indicating the end date of the filter's date range. | No |
| dateRange.slidingDateRangeKey | string | A pre-defined string indicating filter's date range. | No |
| paging.page | integer | A non-zero integer representing the page of the results | No |
| paging.pageSize | integer | A non-negative, non-zero integer indicating the maximum number of results to return at one time. Max page size is 1000 entries. | No |
| sorting.sortColumn | string | A property of Lead object to sort by. E.g. "sorting.SortColumn=CreatedDate". The following sort parameters are accepted: CreatedDate, LostDate, LeadLastName | No |
| sorting.sortingDirection | string | A sorting direction to sort by (acsending or decsending). E.g. "sorting.SortingDirection=acsending" | No |
Header Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| Accept | string | n/a | No |
| Accept-Charset | string | Accept-Charset header (see Fortellis API documentation) | No |
| Accept-Language | string | Accept-Language header (see Fortellis API documentation) | No |
| Accept-Encoding | string | Accept-Encoding header (see Fortellis API documentation) | No |
| Prefer | string | Prefer header (see Fortellis API documentation) | No |
| If-Match | string | If-Match header (see Fortellis API documentation) | No |
| If-None-Match | string | If-None-Match header (see Fortellis API documentation) | No |
| Request-id | string | If-None-Match header (see Fortellis API documentation) | 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 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 502 | Server Error |
Try It Out
-
dateRange.startDate
(string) A date in ISO 8601 format indicating the start date of the filter's date range.
-
dateRange.endDate
(string) A date in ISO 8601 format indicating the end date of the filter's date range.
-
dateRange.slidingDateRangeKey
(string) A pre-defined string indicating filter's date range.
-
paging.page
(integer) A non-zero integer representing the page of the results
-
paging.pageSize
(integer) A non-negative, non-zero integer indicating the maximum number of results to return at one time. Max page size is 1000 entries.
-
sorting.sortColumn
(string) A property of Lead object to sort by. E.g. "sorting.SortColumn=CreatedDate". The following sort parameters are accepted: CreatedDate, LostDate, LeadLastName
-
sorting.sortingDirection
(string) A sorting direction to sort by (acsending or decsending). E.g. "sorting.SortingDirection=acsending"
-
Accept
(string)
-
Accept-Charset
(string) Accept-Charset header (see Fortellis API documentation)
-
Accept-Language
(string) Accept-Language header (see Fortellis API documentation)
-
Accept-Encoding
(string) Accept-Encoding header (see Fortellis API documentation)
-
Prefer
(string) Prefer header (see Fortellis API documentation)
-
If-Match
(string) If-Match header (see Fortellis API documentation)
-
If-None-Match
(string) If-None-Match header (see Fortellis API documentation)
-
Request-id
(string) If-None-Match header (see Fortellis API documentation)
-
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...