List people

GET

/workspaces/{workspace_id}/people

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

API Key

Add parameter in query

x-api-key

Example:

x-api-key: ********************

Path Params

Query Params

Responses

🟢200Success

application/json

Body

🟠400Invalid UUID

🟠401Unauthorized API KEY

🟠403Unauthorized roles

🟠404Entity not found

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://prod.your-api-server.com/api/community/v2/workspaces/43f55840-21e5-45ca-b735-ccd06e097d3a/people?profile_type_ids[]=8d61e885-7023-4a44-923b-3b4aedf8e6a3&sort_by=name-desc' \
--header 'x-api-key: <api-key>'

Response Example

200 - Example 1

{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "profile": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "profile_type_id": "fcb02d6f-d919-45dd-b606-b0bf8279ebd8",
                "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c"
            },
            "last_name": "string",
            "first_name": "string",
            "other_name": "string",
            "pronoun": "string",
            "profile_image_key": "string",
            "inserted_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ],
    "meta": {
        "base": "string",
        "next": "string",
        "previous": "string"
    }
}

Modified at 2025-06-24 12:46:42

Manage Person Block entries by ids

Create Person