Fuel Card API
List fuel cards.
Retrieves the collection of FuelCardResource resources.
Endpoint
GET - https://api.travisroadservices.com/v1/fuel_cards
Copy
Query params
| Parameter | Type | Description |
|---|---|---|
isMainCard
|
string | Filters to return only the main card when set to true. |
status
|
string | Filters by fuel card status (integer). Possible values: 1 (pending), 2 (activated), 3 (blocked), 4 (expired). |
status[]
|
string | Filters by fuel card status (string). Possible values: pending, active, blocked, expired. Multiple values can be passed to broaden the filter. |
cardNumber
|
string | Filters by fuel card number. Partial values are accepted and will return matching results. |
ids[]
|
string | Filters by an array of fuel card IDs. Multiple values can be passed to broaden the filter. |
page
|
string | The collection page number |
itemsPerPage
|
string | The number of items per page |
Request body
No request bodyResponse body
Response 200
FuelCardResource collection
Fields
| Field | Type | Description |
|---|---|---|
id
|
integer | Unique identifier of the fuel card. |
provider
|
integer | ID of the fuel card provider. |
cardNumber
|
string | The fuel card number. |
expirationDate
|
string | Expiration date of the fuel card in YYYY-MM format. |
serviceCode
|
integer | Service code associated with the fuel card. |
linkedVehiclesAmount
|
integer | Number of vehicles linked to this fuel card. |
mainCard
|
boolean | Indicates whether this is the main fuel card for the vehicle. |
status
|
string | Current status of the fuel card (e.g. pending, activated, blocked, expired). |
import
|
object | Import reference that created this fuel card, if applicable. |
id
|
string (uuid) | Unique identifier of the import. |
Example