List Members

Endpoint

GET https://api.parcelengineering.com/api/v1/workspace/members

Returns all members of the workspace with their profile, role, and join date. Members are ordered by join date ascending.

List members costs 0 credits.

Caution

The Workspace API requires the Pro plan. A request from a non-Pro workspace receives 403 forbidden.

Query parameters

Parameter	Type	Required	Description
workspace_id	string (UUID)	No	Override the workspace resolved from your API key. Useful for admin tooling.

Example

cURL

List workspace members

curl https://api.parcelengineering.com/api/v1/workspace/members \
  -H "Authorization: Bearer pcl_your_api_key"

JavaScript

List workspace members

const response = await fetch(
  'https://api.parcelengineering.com/api/v1/workspace/members',
  {
    headers: {
      'Authorization': 'Bearer pcl_your_api_key',
    },
  }
);

const { data, metadata } = await response.json();

Response

Response

{
  "data": {
    "members": [
      {
        "id": "d1e2f3a4-0001-4b7c-9e5d-000000000001",
        "email": "owner@example.com",
        "first_name": "Alex",
        "display_name": "Alex Owner",
        "avatar_object_key": null,
        "last_active_at": "2025-06-28T14:22:00.000Z",
        "role": "owner",
        "joined_at": "2025-01-15T09:00:00.000Z"
      },
      {
        "id": "d1e2f3a4-0002-4b7c-9e5d-000000000002",
        "email": "teammate@example.com",
        "first_name": "Jordan",
        "display_name": "Jordan Teammate",
        "avatar_object_key": null,
        "last_active_at": "2025-06-27T10:05:00.000Z",
        "role": "member",
        "joined_at": "2025-03-01T12:00:00.000Z"
      }
    ]
  },
  "metadata": { "credits": 0 }
}

Response fields

Field	Type	Description
data.members	array	One object per workspace member, ordered by join date ascending.
data.members[].id	string (UUID)	The user’s unique id. Use this as the userId path parameter for update and remove operations.
data.members[].email	string	The member’s email address.
data.members[].first_name	string or null	The member’s first name, if set.
data.members[].display_name	string or null	The member’s display name, if set.
data.members[].avatar_object_key	string or null	Object key for the member’s avatar image, if uploaded.
data.members[].last_active_at	string (ISO 8601) or null	When the member was last active in the workspace.
data.members[].role	string	The member’s role: owner, admin, or member.
data.members[].joined_at	string (ISO 8601)	When the member joined the workspace.
metadata.credits	integer	Always 0.