INinstantly
WorkspaceMember

List workspace member

Changed on

Requires one of the following scopes: workspace_members:read, workspace_members:all, all:read, all:all

get/api/v2/workspace-members

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/workspace-members
  • Auth
    HTTP bearer

Query parameters

limitinteger
Example:10

The number of items to return

starting_afterstring
Example:01956fbd-0eb1-72db-a565-82977a586084

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

acceptedboolean
Example:true

Filter workspace members by invitation acceptance status

searchstring
Example:John

Search by name or email

Response

The list of Workspace Member

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example response

{
  "items": [
    {
      "id": "01a19e6e-27ba-7bbc-892a-bc921a3944e8",
      "email": "user@example.com",
      "user_id": "01a19e6e-27ba-7bbc-892a-bc9328f2127a",
      "user_email": "user@example.com",
      "nickname": "Finance lead",
      "name": {
        "first": "John",
        "last": "Smith"
      },
      "picture_url": "https://example.com/profile-picture.png",
      "role": "editor",
      "timestamp_created": "2026-11-02T22:43:01.690Z",
      "workspace_id": "01a19e6e-27ba-7bbc-892a-bc9413de2bec",
      "issuer_id": "01a19e6e-27ba-7bbc-892a-bc953434e01c",
      "permissions": [
        "unibox.all"
      ]
    }
  ],
  "next_starting_after": "01a19e6e-680d-7636-94a7-5101427351b6"
}

Changes

  • c781051105a8Revision changes
    • warning

      added the new websiteChat.manage enum value to the /// response property for the response status

    • warning

      added the new websiteChat.view enum value to the /// response property for the response status

    • info

      added the optional property // to the response with the status