Workspaces

List workspace members and pending invitations

get/workspaces/{id}/team

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/workspaces/{id}/team
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Path parameters

idstring required

Workspace ID

Query parameters

qstring

Case-insensitive member or invitation email search

role'all' | 'admin' | 'editor' | 'client' | 'viewer'

Filter by role

status'all' | 'active' | 'inactive' | 'pending' | 'created' | 'queued' | 'sent' | 'delivered' | 'delivery_failed' | 'delivery_unavailable' | 'expired' | 'revoked' | 'accepted'

Filter by member access or exact invitation lifecycle state

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

can_manageboolean required

Whether the current user may administer workspace access

current_seatsinteger required

Example response

{
  "$schema": "https://example.com/api/v1/schemas/WorkspaceTeamOutputBody.json",
  "invitations": [
    {
      "$schema": "https://example.com/api/v1/schemas/WorkspaceInvitationResponse.json"
    }
  ],
  "members": [
    {
      "$schema": "https://example.com/api/v1/schemas/WorkspaceMemberResponse.json"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.