Retrieve Assignment

List Equipment Assignments

Path Parameters

id string required
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
Default value: 50
The number of records per page to return
filter object
The fields, operations, and values to filter the records by.
- contact_id object
  eq string required
- ended_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
- created_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
- updated_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
sort object
The fields and direction to sort the results by.
- started_at string
  Possible values: [asc, desc]
- ended_at string
  Possible values: [asc, desc]
- created_at string
  Possible values: [asc, desc]
- updated_at string
  Possible values: [asc, desc]
- id string
  Possible values: [asc, desc]
  Default value: desc

Responses

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
contact_id object
eq string
sorted_by object[]
The sorts applied to the returned record set.
anyOf
MOD1
MOD2
MOD3
MOD4
MOD5
started_at string
Possible values: [asc, desc]
records object[]
id integer
created_at date-time
updated_at date-time
equipment_id integer
The id of the equipment associated with this Equipment Assignment.
contact_id integer
The id of the contact associated with this Equipemnt Assignment.
started_at date-time
The date and time of this Equipemnt Assignment. Dates in the future are accepted. We recommend using ISO-8601 formatted dates to avoid ambiguity.
ended_at date-time
The date and time of this Equipment Assignment ending. We recommend using ISO-8601 formatted dates to avoid ambiguity.
current boolean
Default value: false
Whether this Equipment Assignment is current/active.
future boolean
Default value: false
Whether this Equipment Assignment is set to take place in the future.
contact object
A Contact
id integer
email string
The Contact's email address.
name string
The Contact's full name.
group_id integer
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
default_image_url string
The URL of the Contact's default image/profile photo, if any.
equipment object
id integer
name string
The name for this Equipment.
brand string
The name of the brand which makes this Equipment.
model string
The model name of this Equipment.
serial_number string
The serial number of this Equipment.

{
  "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-09-06",
      "updated_at": "2024-09-06",
      "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"
      }
    }
  ]
}

The format or parameters of the request was invalid

application/json

Schema
Example (from schema)

Schema

errors object
type
items 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"
}

Insufficient permission to perform this operation

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"
}