FLfleetio
Contacts

List Archived Contacts

Returns a list of archived contacts.

get/contacts/archived

Request

Query parameters

start_cursorstring

The start cursor for Keyset pagination.

per_pageinteger

The number of records per page to return

The fields, operations, and values to filter the records by.

archived_at'asc' | 'desc'
id'asc' | 'desc'

The fields and direction to sort the results by.

Response

OK

start_cursorstring nullable

The current start cursor of the records returned.

next_cursorstring nullable

The next cursor to retrieve the next page of records.

per_pageinteger

The maximum number of records returned.

estimated_remaining_countinteger

The number of remaining records including the returned records, up to a maximum of 500.

Example response

{
  "records": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "group_hierarchy": "Group 1|Group 2|Group 3",
      "birth_date": "2023-03-14",
      "street_address": "123 Main St",
      "street_address_line_2": "Apt 1",
      "images": [
        {
          "created_at": "2023-03-14T13:46:27-06:00",
          "updated_at": "2023-03-14T13:46:27-06:00"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.