API reference

Categories

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/categories

List the org's asset categories

The org's category taxonomy for assets — categories whose group is for assets or for every kind of thing — each with its group, by group (as the app orders them) then name. Returned whole, at most 1000. Use an id with GET /assets?category_id=. Read only: the taxonomy is managed in the app. For an OAuth token, empty unless its person is a member of the org. 404 when the org does not have categories.

Scopes: taxonomy:read

Response 200CategoryList
  • dataarray of Categoryrequired

    By group (its order in the app, then name), then name. Returned whole, at most 1000.

    • groupobjectrequired

      The category group (a facet: Genre, Territory…).

      • idstring (uuid)required
      • namestringrequired
    • idstring (uuid)required
    • namestringrequired
    • descriptionstring or nullrequired
    • parent_idstring (uuid) or nullrequired

      The category this one sits under (one level deep at most), or null.

    • is_systembooleanrequired

      A category the platform seeded; it cannot be deleted in the app.

  • next_cursorstring or nullrequired

    Always null: the list is returned whole.

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.
  • 429 rate-limited — the key's request budget is spent; wait Retry-After seconds.
  • 500 internal.