List Vendors
Returns a list of Vendors belonging to your account.
Query Parameters
- start_cursor string
The start cursor for Keyset pagination.
- per_page integer
Possible values:
>= 2
and<= 100
Default value:
50
The number of records per page to return.
- filter object
The fields, operations, and values to filter the records by.
name object
external_id object
created_at object
updated_at object
- sort object
The fields and direction to sort the results by.
- id string
Possible values: [
asc
,desc
]Default value:
desc
- created_at string
Possible values: [
asc
,desc
] - updated_at string
Possible values: [
asc
,desc
]
- 200
- 400
- 401
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- start_cursor string
The current start cursor of the records returned.
- next_cursor string
The next cursor to retrieve the next page of records.
- per_page integer
The maxumum number of records returned.
- estimated_remaining_count integer
The number of remaining records including the returned records, up to a maximum of 500.
filtered_by object[]
sorted_by object[]
records object[]
{
"start_cursor": "string",
"next_cursor": "string",
"per_page": 0,
"estimated_remaining_count": 0,
"filtered_by": [
{
"name": {
"like": "string"
}
},
{
"external_id": {
"eq": "string"
}
},
{
"created_at": {
"lt": "string"
}
},
{
"updated_at": {
"lt": "string"
}
}
],
"sorted_by": [
{
"created_at": "asc"
},
{
"updated_at": "asc"
},
{
"id": "asc"
}
],
"records": [
{
"id": 0,
"created_at": "2024-12-31",
"updated_at": "2024-12-31",
"name": "string",
"phone": "string",
"street_address": "string",
"street_address_line_2": "string",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string",
"website": "string",
"notes": "string",
"fuel": true,
"service": true,
"parts": true,
"vehicle": true,
"contact_name": "string",
"contact_email": "string",
"contact_phone": "string",
"latitude": 0,
"longitude": 0,
"external_id": "string",
"archived_at": "string",
"custom_fields": {},
"labels": [
{
"id": 0,
"name": "string"
}
]
}
]
}
The format or parameters of the request was invalid
- application/json
- Schema
- Example (from schema)
Schema
errors object
{
"errors": {}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
GET /v1/vendors
Request
Request
curl -L -X GET 'https://secure.fleetio.com/api/v1/vendors' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/vendors' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/vendors' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/vendors' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/vendors' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/vendors' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'
curl -L -X GET 'https://secure.fleetio.com/api/v1/vendors' \
-H 'Accept: application/json' \
-H 'Authorization: Token <API_KEY>' \
-H 'Account-Token: <ACCOUNT_TOKEN>' \
-H 'X-Api-Version: 2024-03-15'