Tags

List tags

Returns tags available to the authenticated user. Pass team_id to list a team's tags — requires any of posts.view, posts.create or posts.edit for type=post, or inbox.manage for type=inbox. Omit team_id to list your personal tags.

get/tags

Request

  • Base URL: https://socialbu.com/api/v1
  • URL: https://socialbu.com/api/v1/tags
  • Auth: HTTP bearer

Query parameters

type'post' | 'inbox' required

Which set of tags to list — post tags or inbox tags. Tags are no longer shared between the two.

team_idinteger

Team ID to scope the tag list to. Omit to list personal tags.

Response

Tag list

idinteger
namestring
colorstring nullable

Hex color. Any valid 6-digit hex color is accepted. Null/omitted for the default (uncolored) look.

type'post' | 'inbox' nullable

Whether this is a post tag or an inbox tag. Null on tags created before this distinction existed — those are treated as inbox tags.

user_idinteger nullable
team_idinteger nullable

Set when the tag belongs to a team; omitted/null for personal tags.

conversations_countinteger nullable

Number of inbox conversations this tag is applied to. Only present for type=inbox tags; omitted for post tags, which can never be applied to a conversation.

can_manageboolean

Whether the requesting user can rename or delete this tag. Always true for a personal tag; for a team tag it reflects the team permission required to manage that tag type (posts.edit for type=post, inbox.manage for type=inbox) — a member who can only list or create team tags gets false.

Changes

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