Impartire
Create an account

API reference

Tags

Every path is under https://impartire.com/api/v1. Generated from the API’s own contract, openapi.json (OpenAPI 3.1), which you can load into any OpenAPI tool. Errors are Problems — see Conventions.

GET/api/v1/tags

List the org's tags

Org tags and team tags, ordered by name, each with how many assets and projects carry it. For an OAuth token, a team tag is listed only when its person is in the team (or an org admin).

Scopes: tags:read

Parameters
  • qquery · string

    Only tags whose name starts with this, ignoring case and extra spaces.

  • limitquery · integer

    Page size, default 50. Values above 100 are treated as 100.

  • cursorquery · string

    next_cursor from the previous page, with the other parameters unchanged.

Response 200TagList
  • dataarray of Tagrequired
    • idstring (uuid)required

      The tag's id — what DELETE …/tags/{tag_id} and { id } on POST …/tags take.

    • namestringrequired

      The tag as first typed. Tags are matched by a normalized form: case, extra spaces and invisible characters are ignored.

    • scope"org" | "team"required

      org: the whole org's. team: private to one team (an OAuth token sees it only when its person is in the team or an org admin).

    • teamobject or nullrequired

      The owning team, for a team tag; null for an org tag.

      • idstring (uuid)required
      • namestringrequired
    • usage_countintegerrequired

      How many assets and projects carry the tag, across the org.

  • next_cursorstring or nullrequired

    Pass as cursor to get the next page; null means this is the last page.

Other responses
  • 401 unauthenticated — no key, or an unknown, revoked or expired one.
  • 403 insufficient-scope — the key lacks a required scope.
  • 404 not-found.
  • 422 validation — a bad limit or cursor.
  • 429 rate-limited — the key's request budget is spent; wait Retry-After seconds.
  • 500 internal.