Tags

The tag object

Attribute Type Description
id integer Unique ID for the tag. Use this value in a project’s tag_ids.
name string Display name of the tag. Unique within the account, ignoring case.
created_at datetime Date and time the tag was created. Use the ISO 8601 Format.
updated_at datetime Date and time the tag was last updated. Use the ISO 8601 Format.

Required permissions

Any account user can read the tag vocabulary when project tags are enabled for the account. Accounts without project tags receive a 403 Forbidden status code.

List all tags

Beta endpoint. Fully available, but the response shape may still change. Until it is frozen, every response includes Harvest-Api-Stability: beta.

Returns the tag vocabulary for the account. The tags are returned sorted by name, then by id.

The response contains an object with a tags property that contains an array of up to per_page tags. Each entry in the array is a separate tag object. If no more tags are available, the resulting array will be empty. Several additional pagination properties are included in the response to simplify paginating your tags.

GET /v2/tags
Parameter Type Description
updated_since datetime Only return tags that have been updated since the given date and time.
page integer DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)
per_page integer The number of records to return per page. Can range between 1 and 2000. (Default: 2000)
This endpoint supports cursor-based pagination and therefore deprecates the page parameter. For more information, visit the pagination guide.

Example Request:

curl "https://api.harvestapp.com/v2/tags" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Harvest-Account-Id: $ACCOUNT_ID" \
  -H "User-Agent: MyApp ([email protected])"

Example Response:

{
  "tags": [
    {
      "id": 401,
      "name": "Design",
      "created_at": "2026-09-03T12:00:00Z",
      "updated_at": "2026-09-03T12:00:00Z"
    },
    {
      "id": 405,
      "name": "Website",
      "created_at": "2026-09-03T12:00:00Z",
      "updated_at": "2026-09-03T12:00:00Z"
    }
  ],
  "per_page": 2000,
  "total_pages": 1,
  "total_entries": 2,
  "next_page": null,
  "previous_page": null,
  "page": 1,
  "links": {
    "first": "https://api.harvestapp.com/v2/tags?page=1&per_page=2000",
    "next": null,
    "previous": null,
    "last": "https://api.harvestapp.com/v2/tags?page=1&per_page=2000"
  }
}

Still have questions? We’re happy to help!

Contact Us