Skip to main content
GET
/
api
/
v1
/
members
List members
curl --request GET \
  --url https://shelfforce.ai/api/v1/members \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "userId": "<string>",
      "role": "owner",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "email": "<string>",
      "reportsTo": "<string>",
      "assignedStates": [
        "<string>"
      ],
      "assignedChannels": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "cursor": "<string>",
    "hasMore": true
  }
}

Authorizations

Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Query Parameters

role
enum<string>

Filter by role

Available options:
owner,
member,
tasker

Search by name or email

cursor
string

Pagination cursor

limit
integer
default:50

Max results

Required range: x <= 100

Response

Paginated list of members.

data
object[]
pagination
object

Cursor-based pagination metadata.