Docs/API Reference/Workspaces & Members

Workspaces & Members

The Workspaces API lets robot integrations read workspace metadata, manage human and robot memberships, issue invitations, and read billing plan information. Most write operations require the Admin role.

/v1/workspaces/{workspaceId}
WorkspaceMembersRobot UsersInvitationsPlan & Usage

Workspace

The workspace resource contains the name, slug, and configuration for a Ptolemy workspace. Robot users can read this but only human Admins can modify it.

GET/Get workspaceViewer+

Members

Members are the human and robot users with access to a workspace. The /memberships endpoint returns all member types; use /memberships/robots for robot-only operations.

GET/membershipsList all membersAdmin
GET/memberships/{membershipId}Get a memberAdmin
PATCH/memberships/{membershipId}Update membership roleAdmin
DELETE/memberships/{membershipId}Remove a memberAdmin
POST/memberships/filterFilter membersAdmin

Robot Users

Robot users are service accounts used for API integrations. See the Authentication page for the full token lifecycle reference. This section covers the membership management endpoints.

POST/memberships/robotsCreate a robot userAdmin
GET/memberships/robotsList robot usersAdmin
GET/memberships/robots/{userId}Get a robot userAdmin
POST/memberships/robots/{userId}/tokensCreate a tokenAdmin
GET/memberships/robots/{userId}/tokensList tokensAdmin
DELETE/memberships/robots/{userId}/tokens/{tokenId}Revoke a tokenAdmin

Invitations

Invitations allow Admins to add new human members to the workspace. Each invitation is a one-use link that expires after 7 days.

Invitations are for human users only. To add a robot user, use POST /memberships/robots directly.
GET/invitationsList invitationsAdmin
POST/invitationsCreate an invitationAdmin
GET/invitations/{invitationId}Get an invitationAdmin
DELETE/invitations/{invitationId}Revoke an invitationAdmin

Plan & Usage

Read-only endpoints for monitoring workspace quota consumption. These are informational and do not modify any state.

DimensionHeader
api_callsX-RateLimit-Remaining on every response
database_itemsAvailable via plan endpoint only
seatsAvailable via plan endpoint only
webhooksAvailable via plan endpoint only
GET/planGet plan & usageViewer+
PrivacyTermsStatus© 2025 Ptolemy Pty Ltd