List Tags¶

GET https://api.copper.com/developer_api/v1/tags

Parameters¶

You can include the following parameters in a request to retrieve a list of all Tags and their entity usage counts.

Field	Type	Details	Default
Required Parameters
--
Optional Parameters
sort_by	string	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`.	name
tag_names_only	boolean	When provided, only a list of tag names is provided with no entity usage counts.	false
last_tag_value	boolean	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.	null

Example¶

List of Tags¶

Query200 Response

curl --location --request GET "https://api.copper.com/developer_api/v1/tags?sort_by=name" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json"

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

List of Tags (tag_names_only=true)¶

Query200 Response

curl --location --request GET "https://api.copper.com/developer_api/v1/tags?tag_names_only=true" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json"

[
  "Apples",
  "Bananas"
]