Skip to main content

Roles

A role decides what a member may do in a company account. This lookup resolves the roleId you find on memberships and invitations.

Every endpoint below shows its parameters and response fields in the middle. On the right you find request samples in cURL, JavaScript and Python, an example response and Try it, which sends the request for real with your own token.

Lists the roles a membership can have (resolves `roleId`)​

GET/v1.0/rolesTry it →
Field overview from the specification

Each item has:

  • roleId (string): id of the role.
  • name (string): role name; one of Owner, Admin, Member.

Query parameters

  • fieldsstringoptional

    Comma-separated list of the fields to return. Leave it out and you get every field — including fields added in the future, which is your call to make: name your fields if you want to be shielded from that.

    Only first-level fields can be named. A nested list such as attendees, tags or sectionItems is returned whole or not at all; attendees.name is not supported.

    On a paged response the selection applies to the entries in items; page, pageSize, total and hasMore are always returned. An unknown name is rejected with 400 rather than ignored.

    Selectable here: name, roleId.

    Example: name,roleId

Response

  • roleIdstringrequired

    Id of the role.

  • namestringrequired

    Role name.

    Allowed values: OwnerAdminMember

Status codes

  • 200Success
  • 401

    Missing or invalid bearer token.

  • 429

    Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.

  • 500

    Internal server error.