List chat participants

Get a list of chat participants

get

Supports filtering, sorting, and pagination via query string parameters.

Path parameters

chatIdstringRequired

The chat ID.

Responses

200

OK

application/json

403

Forbidden

application/json

404

Not Found

application/json

get/public/v1/helpdesk/chats/{chatId}/participants

HTTPcURLJavaScriptPython

GET /public/v1/helpdesk/chats/{chatId}/participants HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-07-15T18:44:17.917Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-07-15T18:44:17.917Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "exited": {
          "at": "2026-07-15T18:44:17.917Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "reactivated": {
          "at": "2026-07-15T18:44:17.917Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "revision": 1,
      "chat": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Direct"
      },
      "contact": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-07-15T18:44:17.917Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-07-15T18:44:17.917Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "activated": {
            "at": "2026-07-15T18:44:17.917Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "blocked": {
            "at": "2026-07-15T18:44:17.917Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "deleted": {
            "at": "2026-07-15T18:44:17.917Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "revision": 1,
        "name": "text",
        "blockedReason": "text",
        "email": "text",
        "status": "text",
        "identity": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-07-15T18:44:17.917Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-07-15T18:44:17.917Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1
        },
        "directories": [
          "[Circular Reference]"
        ],
        "chat": true,
        "optOuts": [
          {
            "id": "text",
            "audit": {
              "created": {
                "at": "2026-07-15T18:44:17.917Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "updated": {
                "at": "2026-07-15T18:44:17.917Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "published": {
                "at": "2026-07-15T18:44:17.917Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "unpublished": {
                "at": "2026-07-15T18:44:17.917Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              },
              "deleted": {
                "at": "2026-07-15T18:44:17.917Z",
                "by": {
                  "id": "text",
                  "name": "text",
                  "icon": "text",
                  "revision": 1
                }
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "name": "text",
            "revision": 1,
            "description": "text",
            "optOutAllowed": true,
            "status": "text",
            "note": "text",
            "deleteAllowed": true,
            "statistics": {
              "month": 1,
              "today": 1,
              "week": 1
            },
            "lastUsed": "2026-07-15T18:44:17.917Z",
            "enabledByDefault": true
          }
        ],
        "user": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-07-15T18:44:17.917Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-07-15T18:44:17.917Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "invitationAcceptedAt": "2026-07-15T18:44:17.917Z"
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "email": "text",
          "status": "text",
          "phone": {
            "prefix": "text",
            "number": "text"
          },
          "firstName": "text",
          "lastName": "text",
          "lastLoginAt": "2026-07-15T18:44:17.917Z",
          "settings": {
            "cultureCode": "text",
            "dateFormat": "text",
            "languageCode": "text",
            "numberFormat": {
              "decimalSeparator": "text",
              "groupSeparator": "text"
            },
            "timeFormat": "text",
            "timeZone": "text",
            "optOuts": {
              "objectTypes": [
                "text"
              ]
            }
          },
          "accounts": [
            {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1,
              "type": "Client",
              "status": "Active"
            }
          ],
          "currentAccount": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "type": "Client",
            "status": "Active"
          }
        }
      },
      "identity": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      },
      "account": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active"
      },
      "muted": true,
      "status": "Active",
      "lastReadMessage": {
        "id": "text",
        "revision": 1,
        "content": "text",
        "visibility": "Public",
        "isDeleted": true
      },
      "unreadMessageCount": 1
    }
  ]
}