Get Community Segments

GET

https://2e0a7m2i9j.execute-api.eu-central-1.amazonaws.com/prod/community/v1/segments

The Get Community Segments API retrieves a paginated list of all created segments within your community environment. The API returns segment details including segment ID, name, and description.

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://2e0a7m2i9j.execute-api.eu-central-1.amazonaws.com/prod/community/v1/segments?pageNo=1&pageSize=10' \
--header 'x-api-key: api_key'

Response Example

200 - Example 1

{
    "message": "string",
    "data": {
        "segments": [
            {
                "id": 0,
                "name": "string",
                "created_at": "string"
            }
        ],
        "pagination": {
            "total": 0,
            "page": 0,
            "limit": 0,
            "totalPages": 0
        }
    }
}

Modified at 2025-09-03 12:24:11

Top Community Courses

Add Member To Segment