API ReferenceSegments
Retrieve a segment
GET
Fetch one segment, including its saved condition and materialized member_count.
Requires the segments:read scope — View your segments and who belongs to them.
header
AuthorizationBearer <API Key>API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.
id*stringResource id.
Format
uuidThe segment
application/json- response
A segment as exposed on the v1 API.
id*stringFormat
uuidname*stringdescription*string|nulltype*stringValue in
"DYNAMIC""STATIC"condition*|nulltrack_membership*booleanmember_count*integercreated_at*stringFormat
date-timeupdated_at*stringFormat
date-timecurl -X GET 'https://api.sendly.now/api/v1/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "type": "DYNAMIC", "condition": { "logic": "AND", "groups": [ { "filters": [ { "field": "string", "operator": "equals", "value": null, "unit": "days" } ], "conditions": {} } ] }, "track_membership": true, "member_count": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}