Skip to main content
GET
/
contacts
/
segments
List contact segments
curl --request GET \
  --url https://api.open.cx/contacts/segments \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "page": 123,
  "limit": 123,
  "totalPages": 123,
  "hasNextPage": true,
  "hasPrevPage": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "definition": {
        "or": [
          {
            "and": [
              {
                "type": "<string>"
              }
            ]
          }
        ]
      },
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.open.cx/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1
Required range: 1 <= x <= 9007199254740991
limit
integer
default:20
Required range: 1 <= x <= 100

Response

Default Response

total
number
required
page
number
required
limit
number
required
totalPages
number
required
hasNextPage
boolean
required
hasPrevPage
boolean
required
data
object[]
required