Labels

List labels

Returns your company's labels as a tree: groups and ungrouped labels at the top level, each group carrying the labels inside it. Items are ordered by sortOrder, then by name. Groups go one level deep.

No labels permission is needed: anyone on the team can read the list.

Filtering

  • status picks active labels (the default), archived ones, or both.
  • search matches names, ignoring case. A group is listed when its own name matches or when any of its labels match; it then carries only the matching labels.

Usage counts

usageCount counts labelled passages only on media you can open, so it never reveals anything about files in folders you cannot access. Owners and members with Access all on folders see company-wide counts.

get/labels

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/labels
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Query parameters

status'active' | 'archived' | 'all'

Which labels to return. Leave it out for active. One of: active, archived, all.

searchstring

Text to match against label and group names, ignoring case. Trimmed, up to 80 characters. An empty value returns everything.

Response

Success

status'success'

success on every 2xx response.

Changes

No recorded changes to this operation across all 2 revisions of this API.