Skip to content

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 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). name

Example

List of Tags

1
2
3
4
5
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"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
[
  {
    "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
  }
]