Activities

Search activities

Search activities (use min/max_activity_date for ranges). Response uses pagination envelope (page_number,total,data) so ChatGPT can read pagination info; the X-PW-TOTAL header still exists. Paginate with page_number/page_size (max 200) until received records equal total. Limit to 100K results.

post/activities/search

Request

  • Base URL
    https://api.copper.com/developer_api/v1
  • Auth
    HTTP bearer

Request body

user_idsinteger[]

An array of user IDs to filter by

minimum_activity_dateinteger

Unix timestamp for the minimum activity date to filter by

maximum_activity_dateinteger

Unix timestamp for the maximum activity date to filter by

full_resultboolean

When true, returns all activities matching the criteria (pagination still applies)

sort_bystring

The field on which to sort the results

sort_direction'asc' | 'desc'

The direction in which to sort the results

page_numberinteger

The page number (starting with 1) that you would like to view

page_sizeinteger

The number of entries included in a page of results

Response

Activities retrieved successfully

page_numberinteger required

Current page number (defaults to 1 when not provided in the request).

totalinteger required

Total number of records that match the request filters (equivalent to the X-PW-TOTAL header).

Example response

{
  "page_number": 1,
  "total": 775,
  "data": []
}

Changes

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