Developers API reference Version 1 · generated from the code openapi.json
Routes

binders

Read a binder

GET /api/v1/binders/{binder_id}

A binder, with the role of the account on it.

Required scope: read

Path parameters

  • binder_id integer · required

    Id of the binder.

Response

200 Binder

  • id integer

    Id, unique among the objects of its type.

  • type string

    Always binder.

  • name string

    Its name.

  • role string or null

    Role of the account on it: owner, editor or reader; null when it holds none of its own.

  • online_status string

    online: open to its readers. offline: closed. pending_online / pending_offline: inside a binder that is not online, hence closed; the setting is recorded and applies when the parent goes online.

  • parent_id integer or null

    Id of the binder that holds it; null at the root of a space.

  • organisation_id integer or null

    Id of the organisation whose space it lives in; null in a personal space.

  • owner Owner

    The account that owns it.

    2 fields
    • id integer

      Id of the account.

    • name string

      Its name, or its address when it has none.

  • created_at date-time

    When it was created.

  • updated_at date-time

    When it was last changed.

  • description string

    Free text; may be empty.

  • flows_count integer or null

    Number of flows directly inside. Given in listings, null elsewhere.

  • sub_binders_count integer or null

    Number of binders directly inside. Given in listings, null elsewhere.

Errors

  • 401

    No valid credential.

  • 403

    The credential lacks the required scope, or the account may not do this.

  • 404

    Nothing with that id, or nothing the account may open.

  • 429

    Too many requests; Retry-After gives the seconds to wait.

planner_banner_ad_pt