Skip to main content
GET
/
v0
/
segments
List segments
curl --request GET \
  --url https://api.formo.so/v0/segments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "seg_e3f4g5h6i7j8",
      "projectId": "proj_abc123",
      "title": "High net worth desktop users",
      "filterSet": [
        "{\"field\":\"device\",\"op\":\"equals\",\"value\":\"desktop\"}",
        "{\"field\":\"net_worth_usd\",\"op\":\"greaterOrEqual\",\"value\":100000}"
      ]
    }
  ],
  "page": 1,
  "size": 100,
  "total": 1,
  "has_more": false
}

Authorizations

​
Authorization
string
header
required

Workspace API key (e.g. formo_xxx). Create one in the Formo dashboard under Team Settings > API Keys.

Query Parameters

​
page
integer
default:1

1-indexed page number. Defaults to 1.

Required range: x >= 1
​
size
integer
default:100

Page size. Defaults to 100, capped at 200.

Required range: 1 <= x <= 200

Response

200 - application/json

Paginated list of segments

Pagination cursor returned alongside data on every paginated list endpoint. Use these to walk pages: has_more is true while page * size < total. Combine with the matching Page and Size query parameters to request the next page.

​
page
integer
required

1-indexed page number echoed from the request.

​
size
integer
required

Page size echoed from the request.

​
total
integer
required

Total row count across all pages.

​
has_more
boolean
required

True when more pages remain (page * size < total).

​
data
object[]
required