List segments (filtered/paged)

POST

https://api.veloconnect.me/api/v2/segments/query

Segments (v2)

Last modified:2026-06-01 19:28:25

List segments (filtered/paged).

Authentication: Requires JWT bearer token.

Request body: V2SegmentListFilterModel

Success response (200): SuccessResponseModelOfPagedListGetModelOfV2SegmentGetModel

Request

Authorization

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

cURLHttpiewget

curl --location 'https://api.veloconnect.me/api/v2/segments/query' \
--header 'Content-Type: application/json' \
--data '{
    "pageNumber": 0,
    "pageSize": 0,
    "search": "string",
    "sortBy": "string",
    "sortDescending": true
}'

Response Example

200 - Success Example

{
    "data": [
        {
            "items": [
                {
                    "id": null,
                    "businessId": null,
                    "name": null,
                    "description": null,
                    "sourceType": null,
                    "isDynamic": null,
                    "filterDefinitionJson": null,
                    "createdAt": null,
                    "createdBy": null,
                    "modifiedAt": null,
                    "modifiedBy": null,
                    "contactsCount": null,
                    "maleCount": null,
                    "femaleCount": null,
                    "unspecifiedGenderCount": null,
                    "phoneNumbersCount": null,
                    "emailCount": null
                }
            ],
            "totalCount": 0,
            "pageSize": 0,
            "pageNumber": 0
        }
    ]
}

Modified at 2026-06-01 19:28:25

Export segments

Get segment details