AVavionte
Contacts

Get Contact Activities by Date

Returns a page of the contact's activities, ordered from newest to oldest, filtered by date range and activity type.

get/v1/contact/{contactId}/activities

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/contact/{contactId}/activities
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

contactIdstring required

The identifier for the contact whose activities are being retrieved.

Query parameters

startDatestring

The start date for the activity search, in UTC and formatted as YYYY-MM-DD.

endDatestring

The end date for the activity search, in UTC and formatted as YYYY-MM-DD. The entire day is included. Defaults to startDate and requires startDate.

typeIdinteger

The activity type identifier used to filter the results.

pageinteger

The page number to retrieve, starting at 1.

pageSizeinteger

The number of activities to include per page. Must be between 1 and 100.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A page of contact activities.

pageinteger

The page number returned, starting at 1.

pageSizeinteger

The maximum number of activities on a page.

totalCountinteger

The total number of activities that match the request, across all pages.

Example response

{
  "page": 1,
  "pageSize": 25,
  "totalCount": 62,
  "items": [
    {
      "id": 53892,
      "contactId": 137914,
      "companyID": 4821,
      "typeId": 284,
      "name": "Interview completed",
      "show_in": 1,
      "activityDate": "2024-12-01T14:30:00Z",
      "enteredDate": "2024-12-01T14:35:12Z",
      "notes": "Called to discuss the open requisition.",
      "userId": 42948,
      "contactActivityDetailsDefinitionIds": [
        {
          "id": 311,
          "detailsName": "Left voicemail"
        }
      ]
    }
  ]
}

Changes

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