COcopper
Tasks

Search tasks

Search tasks. Response uses a 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. Limited to 100K results.

post/tasks/search

Request

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

Query parameters

custom_field_computed_valuesboolean

When true, returns computed custom field values (human-readable labels) in addition to option IDs for Dropdown and Multi-select fields. The response will include a 'computed_value' field alongside the 'value' field in custom_fields array.

Request body

tagsstring[]

An array of tags to filter by

assignee_idsinteger[]

An array of assignee IDs to filter by (the user IDs who own these tasks)

statusesstring[]

An array of statuses to filter by

prioritiesstring[]

An array of priorities to filter by

minimum_due_dateinteger

Unix timestamp for the minimum due date

maximum_due_dateinteger

Unix timestamp for the maximum due date

minimum_reminder_dateinteger

Unix timestamp for the minimum reminder date

maximum_reminder_dateinteger

Unix timestamp for the maximum reminder date

minimum_completed_dateinteger

Unix timestamp for the minimum completed date

maximum_completed_dateinteger

Unix timestamp for the maximum completed date

minimum_close_dateinteger

Unix timestamp for the minimum creation date

maximum_close_dateinteger

Unix timestamp for the maximum creation date

minimum_modified_dateinteger

Unix timestamp for the minimum modification date

maximum_modified_dateinteger

Unix timestamp for the maximum modification date

sort_by'name' | 'assigned_to' | 'related_to' | 'status' | 'priority' | 'due_date' | 'reminder_date' | 'completed_date' | 'date_created' | 'date_modified'

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

Example request

{
  "name": {
    "value": "Follow",
    "special_value": [
      {
        "type": "partial"
      }
    ]
  },
  "phrase": {
    "value": "Follow",
    "special_value": [
      {
        "type": "partial"
      }
    ]
  }
}

Response

Tasks 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.