Retrieve Contact

GET 
https://secure.fleetio.com/api/v2/contacts/:id

Retrieves the details of an existing contact.

Request

Path Parameters

id stringrequired

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

The id of the relevant record

Query Parameters

expand[] string[]

Additional attributes that should be returned in the response. Available: group

Responses

200

OK

application/json

Schema

Schema

idId (integer)required
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
namestringnullablerequired
The Contact's full name.
first_namestringnullablerequired
The Contact's first name.
middle_namestringnullablerequired
The Contact's middle name.
group_idintegernullablerequired
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
group_namestringnullablerequired
If this Contact belongs to a Group, this will be the Group's name.
last_namestringnullablerequired
The Contact's last name.
images_countintegerrequired
The number of images associated with this Contact.
documents_countintegerrequired
The number of documents associated with this Contact.
comments_countintegerrequired
The number of Comments associated with this Contact.
emailstringnullable
The Contact's email address.
technicianbooleannullable
Whether this Contact is a Technician.
vehicle_operatorbooleannullable
Whether this Contact is a Vehicle Operator.
employeebooleannullable
Whether this Contact is an Employee.
birth_datedatenullable
The Contact's birth date.
Example: 2023-03-14
street_addressstringnullable
The Contact's street address.
street_address_line_2stringnullable
The second line of the Contact's street address.
citystringnullable
The Contact's city.
regionstringnullable
The Contact's region.
postal_codestringnullable
The Contact's postal code.
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 license class.
license_numberstringnullable
The Contact's license number.
license_statestringnullable
The state 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 mobile phone number belonging to this Contact.
start_datedatenullable
The Contact's start date.
leave_datedatenullable
The Contact's leave date.
hourly_labor_ratefloatnullable
The Contact's hourly rate.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
default_image_urlstringnullablerequired
The URL pointing to the default image for this Contact.
account_membership_idNullableId (integer)nullable
Possible values: >= 1
archived_atdate-timenullable
The date and time at which this Contact was archived, if applicable. null if this Contact is not archived.
Example: 2023-03-14T13:46:27-06:00
user objectnullablerequired
idNullableId (integer)nullable
Possible values: >= 1
emailstringnullable
The email address associated with this User.
usernamestringnullable
The username of this User.
time_zonestringnullable
The timezone set for this User.
user_typestringnullable
This User's type.
Possible values: [admin, regular, owner]
archived_atdate-timenullable
The date and time at which the User was archived (deactivated). If null, the User is not deactivated.
role object
Basic information about this User's Role, if applicable.
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable
vehicles_record_set object
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable
equipments_record_set object
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable
contacts_record_set object
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable
parts_record_set object
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable
inspection_forms_record_set object
idNullableId (integer)nullable
Possible values: >= 1
namestringnullable

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "name": "string",
  "first_name": "string",
  "middle_name": "string",
  "group_id": 0,
  "group_name": "string",
  "last_name": "string",
  "images_count": 0,
  "documents_count": 0,
  "comments_count": 0,
  "email": "string",
  "technician": true,
  "vehicle_operator": true,
  "employee": true,
  "birth_date": "2023-03-14",
  "street_address": "string",
  "street_address_line_2": "string",
  "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": {},
  "default_image_url": "string",
  "account_membership_id": 0,
  "archived_at": "2023-03-14T13:46:27-06:00",
  "user": {
    "id": 0,
    "email": "string",
    "username": "string",
    "time_zone": "string",
    "user_type": "admin",
    "archived_at": "2024-07-29T15:51:28.071Z",
    "role": {
      "id": 0,
      "name": "string"
    },
    "vehicles_record_set": {
      "id": 0,
      "name": "string"
    },
    "equipments_record_set": {
      "id": 0,
      "name": "string"
    },
    "contacts_record_set": {
      "id": 0,
      "name": "string"
    },
    "parts_record_set": {
      "id": 0,
      "name": "string"
    },
    "inspection_forms_record_set": {
      "id": 0,
      "name": "string"
    }
  }
}

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

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

curl -L 'https://secure.fleetio.com/api/v2/contacts/:id' \
-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

id — pathrequired

expand[] — query

ResponseClear

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