Get a segment

Use this method to get a segment by ID.

Learn more about Segments and its use cases.

Please log in to see full path URL. Learn why.

get

/people/3/segments/{segmentId}

Authorizations:

Scopes:

people:manage

people:read

Request rate limit:

10 requests / second (per account)

Learn more

path Parameters

segmentId

required

string

Example: 42

A unique segment identifier.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

Request samples

Example

cURL

Copy

curl -L -g 'https://{baseUrl}/people/3/segments/42' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type

application/json

Copy

Collapse all


{"id": 42,
"name": "VIP Alex Clients",
"description": "Persons named Alex with tag \"VIP Client\"",
"query": 
{"#and": 
[
{"firstName": "Alex"
},
{"#contains": 
{"tags": "VIP Client"
}
}
]
},
"events": 
[
{"definitionId": "addedToCart",
"occurrenceCondition": 
{"operation": "IS",
"times": 5
},
"timelineCondition": 
{"occurred": "ALL",
"operator": "BETWEEN",
"start": 60,
"end": 30,
"units": "DAYS"
},
"payloadConditions": 
[
{"attribute": "itemId",
"operator": "EQ",
"value": "10001"
}
]
}
],
"createdAt": "2025-03-29T19:05:03Z",
"modifiedAt": "2025-03-29T19:05:03Z"
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use