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

sharing

Read the sharing of a binder

GET /api/v1/binders/{entity_id}/sharing

The sharing rules and the recipients: accounts, sharing lists, email domains and pending invitations.

Required scope: share

Path parameters

  • entity_id integer · required

    Id of the binder or flow.

Response

200 Sharing

  • inherit boolean

    Whether it follows the sharing of the binder that holds it instead of rules of its own.

  • reading_access string

    Its own rule: public opens it to anyone who has its link, limited keeps it to its recipients.

  • effective_reading_access string

    The rule that really applies, inheritance included.

  • recipients array of Recipient

    Who it is shared with, pending invitations included.

    6 fields
    • id integer

      Id of the share, unique per type: what the recipient routes take as permission_id (or invitation_id).

    • type string

      user: an account. userslist: a sharing list. domain: every address of an email domain. invitation: an address that has no account yet.

    • name string

      The address, the name of the list, or the domain.

    • permission string

      What the recipient may do.

    • pending boolean

      true for an invitation not accepted yet.

    • sent boolean or null

      Invitations only: whether the invitation email left.

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