v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

List members of a thread

Returns all current members of the specified thread, including both user and agent members. The authenticated user must have visibility into the thread; requests from users without access return 403.

Results are returned as a flat array in the data field. The list is not paginated — all members are returned in a single response.

get/api/v1/threads/{thread}/members

Path parameters

threadstring required

Thread ID (thr_...) whose members should be returned.

Response

Successful response

Example response

{
  "data": [
    {
      "membership_type": "member",
      "thread": "thr_0aBcDeFgHiJkLmNoPqRsTu",
      "user": {
        "alias": "jdoe",
        "app": "dap_0aBcDeFgHiJkLmNoPqRsTu",
        "app_name": "Example Name",
        "email": "user@example.com",
        "id": "usr_0aBcDeFgHiJkLmNoPqRsTu",
        "is_system_user": true,
        "metadata": {
          "key": "value"
        },
        "name": "Example Name",
        "org": "org_0aBcDeFgHiJkLmNoPqRsTu",
        "org_name": "Example Name",
        "org_role": "member",
        "sandbox": "dsb_0aBcDeFgHiJkLmNoPqRsTu",
        "sandbox_name": "Example Name"
      }
    }
  ]
}