Skip to content
OpenPostDocs
OpenPostDocs
Workspaces

List workspace members and pending invitations

GET/workspaces/{id}/team

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Workspace ID

Query Parameters

q?string

Case-insensitive member or invitation email search

Lengthlength <= 200
role?string

Filter by role

Default"all"

Value in

  • "all"
  • "admin"
  • "editor"
  • "viewer"
status?string

Filter by member access or exact invitation lifecycle state

Default"all"

Value in

  • "all"
  • "active"
  • "inactive"
  • "pending"
  • "created"
  • "queued"
  • "sent"
  • "delivered"
  • "delivery_failed"
  • "delivery_unavailable"
  • "expired"
  • "revoked"
  • "accepted"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/workspaces/string/team"
{  "$schema": "https://example.com/api/v1/schemas/WorkspaceTeamOutputBody.json",  "can_manage": true,  "current_seats": 0,  "invitations": [    {      "$schema": "https://example.com/api/v1/schemas/WorkspaceInvitationResponse.json",      "accept_url": "string",      "accepted_at": "string",      "accepted_by_user_id": "string",      "created_at": "string",      "email": "string",      "email_delivery_status": "created",      "email_delivery_updated_at": "string",      "expires_at": "string",      "id": "string",      "invited_by_user_id": "string",      "last_sent_at": "string",      "revoked_at": "string",      "role": "string",      "status": "created",      "workspace_id": "string"    }  ],  "members": [    {      "$schema": "https://example.com/api/v1/schemas/WorkspaceMemberResponse.json",      "created_at": "string",      "deactivated_at": "string",      "email": "string",      "role": "admin",      "status": "active",      "updated_at": "string",      "user_id": "string"    }  ]}