Search workspace members

curl --request POST \
  --url https://{platformHost}/api/public/v1/workspaces/{workspaceId}/members/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": [],
  "statuses": [],
  "roleId": "<string>",
  "emails": [
    "jsmith@example.com"
  ],
  "externalId": "<string>",
  "updatedSince": "2023-11-07T05:31:56Z",
  "include": "projects",
  "limit": 50,
  "cursor": "<string>"
}
'

{
  "success": true,
  "data": {
    "data": [
      {
        "memberId": "0193f1c2-7a4e-7b10-9c3d-5e6f7a8b9c0d",
        "role": {
          "roleId": "builtin.workspace.restricted_member",
          "name": "RESTRICTED_MEMBER",
          "type": "system",
          "source": "direct"
        },
        "status": "pending",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "revision": 1,
        "userId": "<string>",
        "email": "jsmith@example.com",
        "name": "<string>",
        "expiresAt": "2023-11-07T05:31:56Z",
        "externalId": "<string>",
        "attributes": {},
        "assignmentSource": "api",
        "projects": [
          {
            "id": "<string>",
            "role": {
              "roleId": "builtin.workspace.restricted_member",
              "name": "RESTRICTED_MEMBER",
              "type": "system",
              "source": "direct"
            },
            "name": "<string>"
          }
        ],
        "projectsTruncated": true
      }
    ],
    "nextCursor": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

POST

api

public

workspaces

{workspaceId}

members

Search workspace members

curl --request POST \
  --url https://{platformHost}/api/public/v1/workspaces/{workspaceId}/members/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": [],
  "statuses": [],
  "roleId": "<string>",
  "emails": [
    "jsmith@example.com"
  ],
  "externalId": "<string>",
  "updatedSince": "2023-11-07T05:31:56Z",
  "include": "projects",
  "limit": 50,
  "cursor": "<string>"
}
'

{
  "success": true,
  "data": {
    "data": [
      {
        "memberId": "0193f1c2-7a4e-7b10-9c3d-5e6f7a8b9c0d",
        "role": {
          "roleId": "builtin.workspace.restricted_member",
          "name": "RESTRICTED_MEMBER",
          "type": "system",
          "source": "direct"
        },
        "status": "pending",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "revision": 1,
        "userId": "<string>",
        "email": "jsmith@example.com",
        "name": "<string>",
        "expiresAt": "2023-11-07T05:31:56Z",
        "externalId": "<string>",
        "attributes": {},
        "assignmentSource": "api",
        "projects": [
          {
            "id": "<string>",
            "role": {
              "roleId": "builtin.workspace.restricted_member",
              "name": "RESTRICTED_MEMBER",
              "type": "system",
              "source": "direct"
            },
            "name": "<string>"
          }
        ],
        "projectsTruncated": true
      }
    ],
    "nextCursor": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "message": "<string>",
    "messages": [
      "<string>"
    ],
    "retryable": true,
    "details": {}
  }
}

To search workspace members, use this API with the filters in the request body. While this request returns the same results as List workspace members, but it keeps email addresses out of URLs and logs. You can filter by status, role, email addresses, externalId, and updatedSince. You must send either status or statuses, but not both. This API request needs the workspace.members.read scope. Set include to projects to return each member’s project memberships. Results are paginated with a cursor. Pass nextCursor from the response as cursor in the next request.

Authorizations

X-API-Key

string

header

required

Platform key, for example abl_ws_….

Path Parameters

workspaceId

string

required

Minimum string length: 1

Body

application/json

status

enum<string>[]

Maximum array length: 6

Available options:

active,

pending,

expired,

suspended,

deactivated,

locked

statuses

enum<string>[]

Maximum array length: 6

Available options:

active,

pending,

expired,

suspended,

deactivated,

locked

roleId

string

Required string length: 1 - 256

emails

string<email>[]

Maximum array length: 50

Maximum string length: 254

externalId

string

Maximum string length: 256

updatedSince

string<date-time>

include

enum<string>

Available options:

projects

limit

integer

default:50

Required range: 1 <= x <= 200

cursor

string

Maximum string length: 2048

Response

Success

success

enum<boolean>

required

Available options:

true

data

object

required

Show child attributes

APIs

SDKs

Search workspace members

Authorizations

Path Parameters

Body

Response