Skip to main content
GET
Get Segment by ID
This API endpoint does not currently support Team-level scoping. All segments generated using this call will be assigned to the Default Team automatically.

Rate Limit

The rate limit is 100 requests/minute, 1000 requests/hour, and 4000 requests/day.

Authorizations

Authorization
string
header
required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

  • Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
  • Password: Use your API Key, which you can find within the Data tile.

For more information on authentication and getting your credentials, refer here.

Headers

MOE-APPKEY
string
required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

You can send MOE-DBNAME with your database name instead of this header. The request must include one of the two.

MOE-DBNAME
string

Your MoEngage database name. Send this as an alternative to MOE-APPKEY when you identify the workspace by database name. Omit it when MOE-APPKEY is already present.

Path Parameters

id
string
required

The ID of the segment.

Response

Successful retrieval of the segment. Returns the segment details including its filter definition and metadata.

Response schema for filter segment operations (create/update).

data
object

Information about the segment.

response_id
string

A unique identifier for this API response.

type
string

The type of resource referenced in the response.

Example:

"custom_segment"