List Service Tasks

GET 
https://secure.fleetio.com/api/v1/service_tasks

Returns a list of Service Tasks belonging to your account.

Request

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.
name object
likestringrequired
default_vmrs_assembly_id object
eqstringrequired
default_vmrs_component_id object
eqstringrequired
default_vmrs_reason_for_repair_id object
eqstringrequired
default_vmrs_system_group_id object
eqstringrequired
default_vmrs_system_id object
eqstringrequired
service_task_category_id object
eqstringrequired
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.

idSortAscDescDefaultDesc (string)

Possible values: [asc, desc]

Default value: desc

created_atSortAscDesc (string)

Possible values: [asc, desc]

updated_atSortAscDesc (string)

Possible values: [asc, 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
name object
likestringrequired
MOD2
default_vmrs_assembly_id object
eqstringrequired
MOD3
default_vmrs_component_id object
eqstringrequired
MOD4
default_vmrs_reason_for_repair_id object
eqstringrequired
MOD5
default_vmrs_system_group_id object
eqstringrequired
MOD6
default_vmrs_system_id object
eqstringrequired
MOD7
service_task_category_id object
eqstringrequired
MOD8
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD9
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
idSortAscDesc (string)
Possible values: [asc, desc]
MOD2
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
updated_atSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idintegerrequired
created_atdate-timerequired
updated_atdate-timerequired
archived_atdate-timenullable
The date and time at which this Service Task was archived. null if this Service Task is active.
namestringrequired
A name for this Service Task.
Possible values: <= 255 characters
descriptionstringnullablerequired
A description of this Service Task.
expected_duration_in_secondsintegernullable
The expected duration in seconds this Service Task should take to complete.
default_vmrs_assembly_idintegernullable
The ID of the VMRS assembly associated with this Service Task.
default_vmrs_component_idintegernullable
The ID of the VMRS component associated with this Service Task.
default_vmrs_reason_for_repair_idintegernullable
The ID of the VMRS reason for repair associated with this Service Task.
default_vmrs_system_group_idintegernullable
The ID of the VMRS system group associated with this Service Task.
default_vmrs_system_idintegernullable
The ID of the VMRS system associated with this Service Task.
service_task_category_idintegernullable
The ID of the Service Task Category associated with this Service Task.
standard_service_task_idintegernullable
The ID of the Standard Service Task associated with this Service Task.
merged_service_task_idintegernullable
The ID of the Merged Service Task associated with this Service Task.
standardbooleanrequired
Whether or not this Service Task is a Standard Service Task.
is_groupbooleanrequired
Whether or not this Service Task is a group.
service_task_category objectnullable
A Service Task Category
idintegerrequired
namestringrequired
The name of this Service Task Category.
descriptionstringnullablerequired
A description for this Service Task Category.
parent_category_idintegernullable
The ID of the parent Service Task Category.
standardbooleanrequired
Whether or not this Service Task Category is standard.
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "name": {
        "like": "string"
      }
    },
    {
      "default_vmrs_assembly_id": {
        "eq": "string"
      }
    },
    {
      "default_vmrs_component_id": {
        "eq": "string"
      }
    },
    {
      "default_vmrs_reason_for_repair_id": {
        "eq": "string"
      }
    },
    {
      "default_vmrs_system_group_id": {
        "eq": "string"
      }
    },
    {
      "default_vmrs_system_id": {
        "eq": "string"
      }
    },
    {
      "service_task_category_id": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "id": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "archived_at": "2024-07-29T15:51:28.071Z",
      "name": "string",
      "description": "string",
      "expected_duration_in_seconds": 0,
      "default_vmrs_assembly_id": 0,
      "default_vmrs_component_id": 0,
      "default_vmrs_reason_for_repair_id": 0,
      "default_vmrs_system_group_id": 0,
      "default_vmrs_system_id": 0,
      "service_task_category_id": 0,
      "standard_service_task_id": 0,
      "merged_service_task_id": 0,
      "standard": true,
      "is_group": true,
      "service_task_category": {
        "id": 0,
        "name": "string",
        "description": "string",
        "parent_category_id": 0,
        "standard": true
      }
    }
  ]
}

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

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/service_tasks' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

start_cursor — query

per_page — query

filter — query

namelike

default_vmrs_assembly_ideq

default_vmrs_component_ideq

default_vmrs_reason_for_repair_ideq

default_vmrs_system_group_ideq

default_vmrs_system_ideq

service_task_category_ideq

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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