COcopper
Tags

List all tags

Retrieve a list of all tags and their entity usage counts. When tag_names_only=true, returns an array of strings instead of tag objects.

get/tags

Request

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

Query parameters

sort_by'name' | 'count'

Can sort by the tag name or count (the total number of times it is used). Only applicable when tag_names_only=false, otherwise it is auto-sorted by name.

tag_names_onlyboolean

When true, only a list of tag names is provided with no entity usage counts (returns array of strings). When false or omitted, returns full tag objects with counts.

last_tag_valuestring

Requires tag_names_only=true. Allows you to provide a tag value to get all the tags that occur after it in the alphabetically-sorted list. The max page size is 10000 so you can use this to paginate through large tag lists.

Response

Tags retrieved successfully. Response format depends on tag_names_only parameter: array of Tag objects (default) or array of strings (when tag_names_only=true).

OR
string[] required

Array of tag name strings (when tag_names_only=true)

Example response

[
  {
    "name": "Apples",
    "count": 5,
    "count_people": 1,
    "count_leads": 1,
    "count_companies": 1,
    "count_opportunities": 1,
    "count_projects": 1
  }
]

Changes

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