Skip to content
API referenceList workspace members

List workspace members

GET/v1/workspaces/{slug}/members

List workspace members.

Returns the people explicitly added to the workspace, with their workspace role, including pending invitations (is_pending: true). Organization owners and admins can use every workspace without being listed here. Not paginated. Fails with 404 when the workspace does not exist.

Requires membership of the workspace (a member, or a va_ key scoped to it), or organization admin. Anyone else gets 403.

Authorization

  • AuthorizationBearer va_

    A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Path parameters

  • slugstringrequired

    the workspace's slug

Query parameters

  • organizationstringrequired

    the slug of the organization the workspace belongs to

Responses

200application/json
  • membersobject[]

    Every explicit member and pending invitation; the list is not paginated.

    Child attributes
    • user_idstring

      The member's user id. For a pending invitation (someone who has not signed up yet) this is the invited email address until they sign in.

    • emailstring

      The member's email address.

    • namestring

      The member's display name; absent until they have signed in.

    • picture_urlstring

      A URL of the member's profile picture; absent when there is none.

    • roleenum<string>

      The member's workspace role: admin (manage the workspace's resources and members), manager, or member (read the workspace's resources).

      One of "admin", "manager", "member"

    • joined_atstring<date-time>

      When the person was added or invited (ISO 8601 date-time).

    • is_pendingboolean

      True for an invitation the person has not accepted yet by signing up with the invited email.

  • totalinteger<int32>

    The number of entries in members.

NVIDIA Inception Program member

VectorAxis is built by GK Labs, a member of NVIDIA Inception.