Getting Groups/Segments

This page contains the API documentation for the getting all groups/segments in customers account.

Get Segments/Groups

This API endpoint allows you to retrieve segments for your application.

Endpoint URL: https://api-v7.express-chat.com/inbox/segments

HTTP Method: GET

Request Headers

• Authorization: A bearer token is required for authentication. Replace [MASKED_TOKEN] with your valid API token. This token is used to authenticate and authorize the request.

Sample Request

curl 'https://api-v7.express-chat.com/inbox/segments' \
  -H 'Authorization: Bearer [MASKED_TOKEN]' \
  -H 'Content-Type: application/json' \
  -H 'authtype: Key' \
  --compressed

Replace [MASKED_TOKEN] in the request with your actual API token.

Response

The API will respond with a JSON object containing the segments available in your application. The response format may vary depending on the segments you have configured.

Please replace [MASKED_TOKEN] in the request with your actual API token for actual usage.

Here are the response fields for this API response:

Field	Type	Description
success	Boolean	Indicates whether the API request was successful.
message	String	Additional information about the request. Empty if there’s nothing to display.
data	Array	Contains the response data. An empty array means no records were found.
code	Number	HTTP status code of the response. 200 indicates success.

Meaning of this response: The API call was successful, but there is currently no data available to return.

Example Response

{
  "success": true,
  "message": "",
  "data": [],
  "code": 200
}

❓ Got any questions?

If you have any questions, you can look into our repository of FAQs, most likely, you will find your answer here, If not, write us at [email protected]