List Filter Segments

GET

/api/:account_id/filter-segments/

GET

/api/:account_id/filter-segments/

$ curl -G https://app.paymentkit.com/api/account_id/filter-segments/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d module=billing \
>      -d limit=25 \
>      -d offset=0 \
>      --data-urlencode filter={"status":"active"} \
>      -d sortBy=created_at \
>      -d sortOrder=-1 \
>      -d search=premium

1 {
2   "items": [
3     {
4       "id": "seg_123abc456def",
5       "module": "billing",
6       "name": "Active Premium Customers",
7       "filters": [
8         {
9           "type": "subscription_status",
10           "id": "active",
11           "label": "Active"
12         },
13         {
14           "type": "plan_type",
15           "id": "premium",
16           "label": "Premium Plan"
17         }
18       ],
19       "created_by_user_id": "user_789xyz",
20       "created_at": "2024-01-15T09:30:00Z",
21       "updated_at": "2024-01-15T09:30:00Z"
22     }
23   ],
24   "total": 1,
25   "has_more": false
26 }

List filter segments for the current account scoped to a module.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Query parameters

modulestringRequired1-64 characters

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON string)

sortBystring or nullOptional

Field to sort by

sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Response

Successful Response

itemslist of objects

totalinteger

has_moreboolean

Errors

422

Unprocessable Entity Error