List company tags

​

Lists the tags your account has defined, a page at a time. Every tag type comes back in one flat collection; filter by tag_type to narrow it.

A tag belongs to exactly one type of record, so a tag you intend to put on a task must be a task tag. Pass the ids you find here in tag_ids when creating or updating a task.

You only get the tag types you are allowed to list the underlying records for: task tags need permission to see tasks, deal tags need permission to see deals, and so on. A token that cannot list any of them gets a 403.

Filtering

  • filter[name] — partial, case-insensitive match on the tag name.
  • filter[tag_type] — return one type of tag only. Omit it to get all types.
Query Parameters
  • page[number]
    Type: integer
    min:  
    1

    Page to return, starting at 1.

  • page[size]
    Type: integer
    min:  
    1
    max:  
    100

    Records per page. Defaults to 25; anything above 100 is reduced to 100.

  • filter[name]
    Type: string

    Partial, case-insensitive match on the tag name.

  • filter[tag_type]
    Type: string enum

    Return one type of tag only. Omit to get every type.

    values
    • client
    • deal
    • project
    • vendor
    • task
    • time_entry
    • expense
    • supplier
Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/public-api/v1/company_tags
curl https://app.hellobonsai.com/public-api/v1/company_tags \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": 7,
      "name": "VIP",
      "tag_type": "client",
      "color": "#520EB0"
    }
  ],
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e",
    "pagination": {
      "page": 1,
      "page_size": 25,
      "has_more": true
    }
  }
}

A page of tags, grouped by type and then sorted by name.