API referenceSegments
Get segment
GET
bearerAuthheader
AuthorizationBearer <API key>Project API key (cr_sk_...)
id*stringFormat
uuidSegment
application/json- response
segment_id*stringFormat
uuidname*stringdescription?string|nullrules?status*stringValue in
"active""archived"created_at*stringFormat
date-timeupdated_at*stringFormat
date-timearchived_at?|Format
date-timecontact_count*integerLive count of Contacts in this Segment with at least one offerable device (preview query with no platform or Category filter).
scheduled_message_count*integerMessages in scheduled or preparing whose targeting source_segment_id is this Segment.
curl -X GET 'https://api.comraid.io/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "segment_id": "0dbbf761-5b2d-4647-8bfa-2b714456749c", "name": "string", "description": "string", "rules": { "operator": "and", "conditions": [ { "field": "string", "key": "string", "op": "string", "value": null } ] }, "status": "active", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "archived_at": "2019-08-24T14:15:22Z", "contact_count": 0, "scheduled_message_count": 0}Batch Segment contact and scheduled-message counts POST
Returns live `contact_count` and `scheduled_message_count` for a page of Segment IDs (saved UUIDs or builtin `seg_sys_*`). Dashboard list rows call this after the list loads. `contact_count` matches targeting preview with no platform or Category filter (Contacts with at least one offerable device).
Archive segment DELETE
Next Page