Skip to main content
GET
/
configuration
/
v1
/
segments
/
{segmentId}
Retrieve a segment
curl --request GET \
  --url https://api.sandbox.asapp.com/configuration/v1/segments/{segmentId} \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>'
{
  "id": "USER_SUPPORT",
  "name": "Support",
  "query": {
    "type": "raw",
    "raw": "TRUE"
  },
  "structuredDataFieldIds": []
}

Authorizations

​
asapp-api-id
string
header
required
​
asapp-api-secret
string
header
required

Path Parameters

​
segmentId
string
required

Identifier of the segment

Response

Successfully retrieved the seg,emt.

Segment

​
id
string

The id of the segment

​
name
string

The name of the segment

​
query
object

A query that defines which conversations belong to this segment based on their metadata.

​
structuredDataFieldIds
string[]

The ids of the structured data fields that will be used to generate the structured data for the conversation.

⌘I