Skip to main content
GET
/
api
/
workspace
/
{workspaceId}
/
members
List workspace members
curl --request GET \
  --url https://app.alana.shopping/api/workspace/{workspaceId}/members \
  --header 'Authorization: Bearer <token>'
{
  "members": [
    {
      "id": "member_1a2b3c",
      "workspace_id": "ws_1a2b3c4d",
      "user_id": "user_xyz789",
      "role": "owner",
      "status": "active",
      "invited_email": null,
      "user_email": "[email protected]",
      "user_full_name": "John Doe",
      "user_avatar_url": "https://cdn.alana.shopping/avatars/user_xyz789.jpg",
      "has_2fa": true,
      "joined_at": "2024-01-10T08:00:00Z",
      "created_at": "2024-01-10T08:00:00Z"
    }
  ],
  "pending_invites": [
    {
      "id": "member_2d3e4f",
      "workspace_id": "ws_1a2b3c4d",
      "user_id": null,
      "role": "editor",
      "status": "invited",
      "invited_email": "[email protected]",
      "invited_by": "user_xyz789",
      "invited_at": "2024-02-10T14:00:00Z",
      "created_at": "2024-02-10T14:00:00Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "has_more": false
  }
}

Authorizations

Authorization
string
header
required

Bearer token authentication. Obtain a token via the authentication endpoint and include it in the Authorization header: Authorization: Bearer <token>

Path Parameters

workspaceId
string
required

The workspace ID

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string
status
enum<string>
Available options:
active,
invited,
suspended
role
enum<string>
Available options:
owner,
admin,
editor,
moderator,
analyst,
viewer

Response

Members and invitations retrieved successfully

members
object[]
pending_invites
object[]
pagination
object