For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
  • API Reference
      • GETList Members
      • POSTCreate Invite
      • DELRemove Member
      • PATCHUpdate Member Role
      • DELRevoke Invite
      • PATCHUpdate Invite Role
      • POSTAccept Invite
  • Python SDK
    • Install
    • Usage
    • Errors
  • CLI
    • Overview
LogoLogo
API Referenceworkspace-members

List Members

GET
/api/v1/workspaces/:ws_id/members
GET
/api/v1/workspaces/:ws_id/members
$curl https://api.onepin.ai/api/v1/workspaces/ws_id/members \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json"
1{
2 "data": [
3 {
4 "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
5 "user_id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
6 "email": "jane.doe@example.com",
7 "first_name": "Jane",
8 "last_name": "Doe",
9 "image_url": "https://cdn.onepin.ai/avatars/jane_doe.png",
10 "role": "admin",
11 "last_active_at": "2024-01-15T09:30:00Z",
12 "status": "active"
13 },
14 {
15 "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
16 "user_id": null,
17 "email": "pending.invite@example.com",
18 "first_name": null,
19 "last_name": null,
20 "image_url": null,
21 "role": "member",
22 "last_active_at": null,
23 "status": "pending"
24 }
25 ],
26 "meta": {
27 "request_id": "7f9c2ba4-3d6a-4f1a-9f3e-2b7a1c9d8e4f",
28 "timestamp": "2024-01-15T09:30:00Z"
29 },
30 "pagination": {
31 "limit": 25,
32 "next": "https://api.onepin.ai/api/v1/workspaces/d290f1ee-6c54-4b01-90e6-d701748f0851/members?page=2",
33 "prev": null
34 }
35}
List active members and pending invites for a workspace.
Was this page helpful?
Previous

Create Invite

Next
Built with

Authentication

AuthorizationBearer
Clerk JWT token

Path parameters

ws_idstringRequiredformat: "uuid"

Response

Successful Response
datalist of objects
metaobject
paginationobject

Errors

422
Unprocessable Entity Error