Team

List workspace members and pending invites

Any active member of the workspace (viewer and up). Brand-limited callers only see brand ids they can access. Never returns invite links or tokens. Access: an API key that a person granted "Manage team" in /dashboard/api (members:read and members:write). Browser sessions are refused with api_key_required; the scopes can never be requested through POST /api/v1/api-keys. ChatGPT, Claude and other OAuth connections hold both scopes implicitly (when their grant includes accounts:write) but may call this endpoint only while the person is an owner or admin of the workspace; otherwise 403 team_management_requires_admin. A key bound to another workspace, or a caller who is not a member, gets 404; a caller whose seat was removed gets 403 workspace_access_revoked. Scope: members:read.

get/api/v1/workspaces/{workspaceId}/members

Request

  • Base URL: https://www.poster.ly
  • URL: https://www.poster.ly/api/v1/workspaces/{workspaceId}/members
  • Auth: HTTP bearer

Path parameters

workspaceIdstring uuid required

Workspace ID (from whoami).

Response

Members, pending invites and seat usage.

workspace_idstring uuid

Example response

{
  "workspace_id": "1c9e7f2a-3b4d-4e5f-8a6b-7c8d9e0f1a2b",
  "members": [
    {
      "id": "5d1f0c3e-2a4b-4c6d-8e9f-0a1b2c3d4e5f",
      "user_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "email": "owner@agency.com",
      "name": "Olive",
      "role": "owner",
      "status": "active",
      "brand_ids": [],
      "joined_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z"
    },
    {
      "id": "6e2a1d4f-3b5c-4d7e-9f0a-1b2c3d4e5f6a",
      "user_id": "8b7c6d5e-4f3a-4b2c-9d1e-0f9a8b7c6d5e",
      "email": "sam@agency.com",
      "name": null,
      "role": "editor",
      "status": "active",
      "brand_ids": [
        "9f6d99a4-b0e0-4ee0-8949-6a87786a52cc"
      ],
      "joined_at": "2026-02-01T00:00:00.000Z",
      "created_at": "2026-02-01T00:00:00.000Z"
    }
  ],
  "invites": [
    {
      "id": "7f3b2e5a-4c6d-4e8f-a01b-2c3d4e5f6a7b",
      "email": "new@agency.com",
      "role": "viewer",
      "status": "pending",
      "brand_ids": [],
      "expires_at": "2026-09-30T12:00:00.000Z",
      "created_at": "2026-09-23T12:00:00.000Z"
    }
  ],
  "usage": {
    "active_members": 2,
    "pending_invites": 1,
    "seats_used": 3
  }
}

Changes

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