List Watchers

GET 
https://secure.fleetio.com/api/v1/watchers/:watchable_type/:id

Returns a list of Watchers as an array of Contact objects for a given Watchable type and ID. The ID should be that of the Watchable type being queried.

Request

Path Parameters

watchable_type stringrequired

Possible values: [charging_entry, contact_renewal_reminder, equipment, expense_entry, fuel_entry, issue, purchase_order, service_entry, service_reminder, vehicle, vehicle_assignment, vehicle_renewal_reminder, vendor, work_order]

The Watchable type

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.
email object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
name object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
group_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.
group_idSortAscDesc (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
email object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
MOD2
last_name object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
MOD3
group_id object
eqstringrequired
MOD4
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD5
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
group_idSortAscDesc (string)
Possible values: [asc, desc]
MOD2
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD4
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idinteger
emailstringnullable
The Contact's email address.
namestringnullable
The Contact's full name.
group_idintegernullable
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
employeebooleannullable
Whether or not the Contact is an employee.
employee_numberstringnullable
The employee number of the Contact.
default_image_urlstringnullable
The URL of the Contact's default image/profile photo, if any.
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "email": {
        "like": "string"
      }
    },
    {
      "last_name": {
        "like": "string"
      }
    },
    {
      "group_id": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "group_id": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "email": "string",
      "name": "string",
      "group_id": 0,
      "employee": true,
      "employee_number": "string",
      "default_image_url": "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"
}

404

The requested resource could not be located

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

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

watchable_type — pathrequired

---charging_entrycontact_renewal_reminderequipmentexpense_entryfuel_entryissuepurchase_orderservice_entryservice_remindervehiclevehicle_assignmentvehicle_renewal_remindervendorwork_order

id — pathrequired

start_cursor — query

per_page — query

filter — query

emaillikeeq

namelikeeq

group_ideq

created_atltltegtgte

updated_atltltegtgte

sort — query

group_id---ascdesc

created_at---ascdesc

updated_at---ascdesc

id---ascdesc

ResponseClear

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