List Contacts

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

Returns a list of your contacts.

Request

Responses

200

OK

Response Headers

X-PaginationLimit

The per page limit. Currently set to 100 but subject to change at any time.

X-Pagination-Current-Page

The current page. Defaults to 1.

X-Pagination-Total-Pages

The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

X-Pagination-Total-Count

The total number of records in the result set (across all pages).

application/json

Schema

Schema

Array [
idinteger
created_atdate-time
updated_atdate-time
emailstringnullable
The Contact's email address.
namestringnullable
The Contact's full name.
first_namestringnullable
The Contact's first name.
middle_namestringnullable
The Contact's middle name.
last_namestringnullable
The Contact's last name.
images_countinteger
The number of images associated with this Contact.
Possible values: >= 0
documents_countinteger
The number of documents associated with this Contact.
Possible values: >= 0
comments_countinteger
The number of comments associated with this Contact.
Possible values: >= 0
group_idintegernullable
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
group_namestringnullable
If this Contact belongs to a Group, this will be the Group's name.
group_hierarchystringnullable
If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.
Example: Group 1|Group 2|Group 3
technicianbooleannullable
Whether or not the Contact is a Technician.
vehicle_operatorbooleannullable
Whether or not the Contact is a Vehicle Operator.
employeebooleannullable
Whether or not the Contact is an Employee.
birth_datedatenullable
The Contact's birth date.
Example: 2023-03-14
street_addressstringnullable
The Contact's street address.
Example: 123 Main St
street_address_line_2stringnullable
The Contact's street address line 2.
Example: Apt 1
citystringnullable
The Contact's city.
regionstringnullable
The Contact's region, state, or province.
postal_codestringnullable
The Contact's postal code, zip code, or equivalent.
countrystringnullable
The Contact's country.
employee_numberstringnullable
The Contact's employee number.
job_titlestringnullable
The Contact's job title.
Possible values: <= 255 characters
license_classstringnullable
The Contact's driver's license class.
license_numberstringnullable
The Contact's driver's license number.
license_statestringnullable
The locality which issued the Contact's license.
license_expirationdatenullable
The Contact's driver's license expiration date.
Example: 2023-03-14
home_phone_numberstringnullable
The Contact's home phone number.
mobile_phone_numberstringnullable
The Contact's mobile phone number.
work_phone_numberstringnullable
The Contact's work phone number.
other_phone_numberstringnullable
Any other phone number for this Contact.
start_datedatenullable
When the Contact started working for the company, if applicable.
leave_datedatenullable
When the Contact left or will leave the company, if applicable.
hourly_labor_ratefloatnullable
The Contact's hourly rate.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
attachment_permissions objectnullable
read_photosboolean
Indicates whether the user has read permission for photos.
manage_photosboolean
Indicates whether the user has permission to manage (eg. upload, delete) photos.
read_documentsboolean
Indicates whether the user has read permission for documents.
manage_documentsboolean
Indicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_urlstringnullable
The URL of the Contact's default image/profile photo, if any.
userobjectnullable
If the Contact is a Fleetio User, those details will be included here.
account_membership_idNullableId (integer)nullable
Possible values: >= 1
last_api_requestdate-timenullable
The last date and time this Contact's associated User made an API request. Null if Contact is not assocated with a User.
last_web_accessdate-timenullable
The last date and time this Contact's associated User signed into the web application. Null if Contact is not assocated with a User.
last_mobile_app_accessdate-timenullable
The last date and time this Contact's associated User used the mobile app. Null if Contact is not assocated with a User.
]

Example (auto)

[
  {
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "email": "string",
    "name": "string",
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "images_count": 0,
    "documents_count": 0,
    "comments_count": 0,
    "group_id": 0,
    "group_name": "string",
    "group_hierarchy": "Group 1|Group 2|Group 3",
    "technician": true,
    "vehicle_operator": true,
    "employee": true,
    "birth_date": "2023-03-14",
    "street_address": "123 Main St",
    "street_address_line_2": "Apt 1",
    "city": "string",
    "region": "string",
    "postal_code": "string",
    "country": "string",
    "employee_number": "string",
    "job_title": "string",
    "license_class": "string",
    "license_number": "string",
    "license_state": "string",
    "license_expiration": "2023-03-14",
    "home_phone_number": "string",
    "mobile_phone_number": "string",
    "work_phone_number": "string",
    "other_phone_number": "string",
    "start_date": "2024-07-29",
    "leave_date": "2024-07-29",
    "hourly_labor_rate": 0,
    "custom_fields": {},
    "attachment_permissions": {
      "read_photos": true,
      "manage_photos": true,
      "read_documents": true,
      "manage_documents": true
    },
    "default_image_url": "string",
    "user": {},
    "account_membership_id": 0,
    "last_api_request": "2024-07-29T15:51:28.071Z",
    "last_web_access": "2024-07-29T15:51:28.071Z",
    "last_mobile_app_access": "2024-07-29T15:51:28.071Z"
  }
]

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/contacts' \
-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

ResponseClear

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