Retrieve Assignment

GET 
https://secure.fleetio.com/api/v1/equipment/:id/assignments

List Equipment Assignments

Request

Path Parameters

id stringrequired

Possible values: Value must match regular expression ^[0-9]+$

The id of the relevant record

Query Parameters

start_cursor string

The start cursor for Keyset pagination.

per_page integer
Possible values: >= 2 and <= 100
The number of records per page to return
Default value: 50
filter object
The fields, operations, and values to filter the records by.
contact_id object
eqstringrequired
ended_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
sort object
The fields and direction to sort the results by.
started_atSortAscDesc (string)
Possible values: [asc, desc]
ended_atSortAscDesc (string)
Possible values: [asc, desc]
created_atSortAscDesc (string)
Possible values: [asc, desc]
updated_atSortAscDesc (string)
Possible values: [asc, desc]
idSortAscDescDefaultDesc (string)
Possible values: [asc, desc]
Default value: desc

Responses

200

OK

application/json

Schema

Schema

start_cursorstringnullable
The current start cursor of the records returned.
next_cursorstringnullable
The next cursor to retrieve the next page of records.
per_pageinteger
The maxumum number of records returned.
estimated_remaining_countinteger
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.
Array [
anyOf
MOD1
contact_id object
eqstringrequired
MOD2
ended_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD3
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD4
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
]
sorted_by object[]
The sorts applied to the returned record set.
Array [
anyOf
MOD1
started_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
ended_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD4
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD5
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idintegerrequired
created_atdate-timerequired
updated_atdate-timerequired
equipment_idintegerrequired
The id of the equipment associated with this Equipment Assignment.
contact_idintegerrequired
The id of the contact associated with this Equipemnt Assignment.
started_atdate-timenullablerequired
The date and time of this Equipemnt Assignment. Dates in the future are accepted. We recommend using ISO-8601 formatted dates to avoid ambiguity.
Example: 2023-03-14T13:46:27-06:00
ended_atdate-timenullablerequired
The date and time of this Equipment Assignment ending. We recommend using ISO-8601 formatted dates to avoid ambiguity.
Example: 2023-03-14T13:46:27-06:00
currentbooleanrequired
Whether this Equipment Assignment is current/active.
Default value: false
futurebooleanrequired
Whether this Equipment Assignment is set to take place in the future.
Default value: false
contact objectnullablerequired
A Contact
idintegerrequired
emailstringnullable
The Contact's email address.
namestringnullablerequired
The Contact's full name.
group_idintegernullable
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
default_image_urlstringnullablerequired
The URL of the Contact's default image/profile photo, if any.
equipment objectnullablerequired
idintegerrequired
namestringrequired
The name for this Equipment.
brandstringnullablerequired
The name of the brand which makes this Equipment.
modelstringnullablerequired
The model name of this Equipment.
serial_numberstringnullablerequired
The serial number of this Equipment.
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "contact_id": {
        "eq": "string"
      }
    },
    {
      "ended_at": {
        "lt": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "started_at": "asc"
    },
    {
      "ended_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "equipment_id": 0,
      "contact_id": 0,
      "started_at": "2023-03-14T13:46:27-06:00",
      "ended_at": "2023-03-14T13:46:27-06:00",
      "current": false,
      "future": false,
      "contact": {
        "id": 0,
        "email": "string",
        "name": "string",
        "group_id": 0,
        "default_image_url": "string"
      },
      "equipment": {
        "id": 0,
        "name": "string",
        "brand": "string",
        "model": "string",
        "serial_number": "string"
      }
    }
  ]
}

400

The format or parameters of the request was invalid

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

403

Insufficient permission to perform this operation

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/equipment/:id/assignments' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

start_cursor — query

per_page — query

filter — query

contact_ideq

ended_atltltegtgte

created_atltltegtgte

updated_atltltegtgte

sort — query

started_at---ascdesc

ended_at---ascdesc

created_at---ascdesc

updated_at---ascdesc

id---ascdesc

ResponseClear

Click the Send API Request button above and see the response here!