Skip to main content
GET
/
v1
/
segments
cURL
curl --request GET \
  --url https://api.comm.com/api/v1/segments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "name": "<string>",
      "query": "<string>",
      "is_active": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer | null
​
per_page
integer | null
​
search
string
​
type
enum<string>
Available options:
numbers,
emails
​
campaign_id
string<uuid>
​
search_ids
string<uuid>[]

Response

Array of SegmentResource

​
data
SegmentResource · object[]
required