List project members

Cursor-paginated list of project members.

Required scope: project.members.read

GET /api/public/v1/projects/{projectId}/members

List project members

cURL

curl --request GET \
  --url https://{platformHost}/api/public/v1/projects/{projectId}/members \
  --header 'X-API-Key: <api-key>'

200

{
  "success": true,
  "data": {
    "data": [
      {
        "memberId": "<string>",
        "userId": "<string>",
        "role": {
          "roleId": "builtin.workspace.restricted_member",
          "name": "RESTRICTED_MEMBER",
          "type": "system",
          "source": "direct"
        },
        "revision": 1,
        "email": "[e-mail]",
        "name": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "nextCursor": "<string>"
  }
}

You can list the members of a project using this endpoint. This request needs the project.members.read scope. You must provide a workspace key or a project key bound to this project.

The results are paginated with a cursor. Pass nextCursor from the response as cursor in the next request. Each item includes the workspace memberId, the member’s project role, and the revision.

Authorizations

platformApiKeybearerPlatformKey

X-API-Key · string · header · required

Platform key, for example abl_ws_….

Path Parameters

projectId · string · required

Minimum string length: 1

Query Parameters

limit · integer · default: 50

Required range: 1 <= x <= 200

cursor · string

Maximum string length: 2048

Response

200

application/json

Success

success · enum<boolean> · required

Available options: true

data · object · required

Show child attributes