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
oneOf- MOD1
- MOD2
like string requiredeq string requiredexternal_id object
eq string requiredcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string required
- 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[]
The filters applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
- MOD4
name object
oneOf- MOD1
- MOD2
like stringeq stringexternal_id object
eq stringcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringsorted_by object[]
The sorts applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
created_at stringPossible values: [
asc
,desc
]updated_at stringPossible values: [
asc
,desc
]id stringPossible values: [
asc
,desc
]records object[]
id integercreated_at date-timeupdated_at date-timename stringThe name of the Vendor.
phone stringThe phone number of the Vendor.
street_address stringThe street address of the Vendor.
street_address_line_2 stringThe second line of the street address of the Vendor.
city stringThe city of the Vendor.
region stringThe region, state, province, or territory of the Vendor.
postal_code stringThe postal code or ZIP code of the Vendor.
country stringThe country of the Vendor.
website stringThe website of the Vendor.
notes stringAdditional notes about the Vendor.
fuel booleanIndicates whether the Vendor provides fuel.
service booleanIndicates whether the Vendor provides service.
parts booleanIndicates whether the Vendor provides parts.
vehicle booleanIndicates whether the Vendor provides vehicles.
contact_name stringThe name of the contact person for the Vendor.
contact_email stringThe email address of the contact person for the Vendor.
contact_phone stringThe phone number of the contact person for the Vendor.
latitude floatThe latitude of the Vendor's location.
longitude floatThe longitude of the Vendor's location.
external_id stringThe external identifier of the Vendor.
archived_at stringThe date and time when the Vendor was archived, if applicable.
custom_fields object*Full details on working with Custom Fields here.
labels object[]
id integerPossible values:
>= 1
name string
{
"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-10-07",
"updated_at": "2024-10-07",
"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
typeitems string
{
"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"
}