Skip to main content

List Contacts

Returns a list of your Contacts.

Query Parameters
  • expand[] string[]
Responses

OK

Response Headers

  • X-PaginationLimit string

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

  • X-Pagination-Current-Page string

    The current page. Defaults to 1.

  • X-Pagination-Total-Pages string

    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 string

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

Schema

array
  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

    The date and time at which this record was most recently updated.

  • name string

    The Contact's full name.

  • first_name string

    The Contact's first name.

  • middle_name string

    The Contact's middle name.

  • group_id integer

    If this Contact belongs to a Group, this will be the Fleetio ID of that Group.

  • group_name string

    If this Contact belongs to a Group, this will be the Group's name.

  • last_name string

    The Contact's last name.

  • images_count integer

    The number of images associated with this Contact.

  • documents_count integer

    The number of documents associated with this Contact.

  • comments_count integer

    The number of Comments associated with this Contact.

  • email string

    The Contact's email address.

  • technician boolean

    Whether this Contact is a Technician.

  • vehicle_operator boolean

    Whether this Contact is a Vehicle Operator.

  • employee boolean

    Whether this Contact is an Employee.

  • birth_date date

    The Contact's birth date.

  • street_address string

    The Contact's street address.

  • street_address_line_2 string

    The second line of the Contact's street address.

  • city string

    The Contact's city.

  • region string

    The Contact's region.

  • postal_code string

    The Contact's postal code.

  • country string

    The Contact's country.

  • employee_number string

    The Contact's employee number.

  • job_title string

    Possible values: <= 255 characters

    The Contact's job title.

  • license_class string

    The Contact's license class.

  • license_number string

    The Contact's license number.

  • license_state string

    The state which issued the Contact's license.

  • license_expiration date

    The Contact's driver's license expiration date.

  • home_phone_number string

    The Contact's home phone number.

  • mobile_phone_number string

    The Contact's mobile phone number.

  • work_phone_number string

    The Contact's work phone number.

  • other_phone_number string

    Any other mobile phone number belonging to this Contact.

  • start_date date

    The Contact's start date.

  • leave_date date

    The Contact's leave date.

  • hourly_labor_rate float

    The Contact's hourly rate.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • default_image_url string

    The URL pointing to the default image for this Contact.

  • account_membership_id NullableId

    Possible values: >= 1

  • user object
  • id NullableId

    Possible values: >= 1

  • email string

    The email address associated with this User.

  • username string

    The username of this User.

  • time_zone string

    The timezone set for this User.

  • user_type string

    Possible values: [admin, regular]

    This User's type.

  • archived_at date-time

    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.

  • id NullableId

    Possible values: >= 1

  • name string
  • vehicles_record_set object
  • id NullableId

    Possible values: >= 1

  • name string
  • equipments_record_set object
  • id NullableId

    Possible values: >= 1

  • name string
  • contacts_record_set object
  • id NullableId

    Possible values: >= 1

  • name string
  • parts_record_set object
  • id NullableId

    Possible values: >= 1

  • name string
  • inspection_forms_record_set object
  • id NullableId

    Possible values: >= 1

  • name string
Loading...