API · Segments

Retrieve Segment

Retrieve a segment (requires full access).

GET/segments/{id}Full access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	Opaque resource id.

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X GET "$OPENSEND_BASE_URL/segments/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "segment",
  "id": "YOUR_ID",
  "name": "example",
  "created_at": "example"
}

Deleting a segment preserves contacts and cleans memberships in batches.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.