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

organisation

List members

GET /api/v1/organisation/members

The members of the organisation with their root role, one page at a time.

Required scope: org:admin

Query parameters

  • q string · optional

    What to look for, 2 to 200 characters.

  • role string or null · optional

    Only the members with this root role: admin, editor or reader.

  • limit integer · optional

    Page size, 1 to 200 (default 50).

  • cursor string or null · optional

    next_cursor of the previous page.

Response

200 Members

  • items array of Member

    One page of members.

    6 fields
    • id integer

      Id of the member.

    • email string

      Their address.

    • first_name string

      First name; may be empty.

    • last_name string

      Last name; may be empty.

    • role string

      Root role: admin, editor or reader.

    • registered boolean

      false while the person has not accepted their invitation.

  • next_cursor string or null

    What to send as cursor for the next page; null on the last one.

Errors

  • 401

    No valid credential.

  • 403

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

  • 422

    A value is missing or malformed.

  • 429

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

planner_banner_ad_pt