Get the Segments for a Contact

GET

/api/Segment/ByContact/:contactId

GET

/api/Segment/ByContact/:contactId

curl -G https://api.virtuoussoftware.com/api/Segment/ByContact/contactId \
     -H "Authorization: Bearer <token>" \
     -d skip=1 \
     -d take=1

200Campaigns_getTheSegmentsForAContact_example

{
  "list": [
    {
      "id": "<integer>",
      "name": "<string>",
      "description": "<string>",
      "code": "<string>",
      "communicationId": "<integer>",
      "communicationName": "<string>",
      "campaignId": "<integer>",
      "campaignName": "<string>",
      "segmentOrganizerId": "<integer>"
    },
    {
      "id": "<integer>",
      "name": "<string>",
      "description": "<string>",
      "code": "<string>",
      "communicationId": "<integer>",
      "communicationName": "<string>",
      "campaignId": "<integer>",
      "campaignName": "<string>",
      "segmentOrganizerId": "<integer>"
    }
  ],
  "total": "<integer>"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

contactIdstringRequired

Query parameters

skipintegerOptional

The skip.

takeintegerOptional

The take.

Response

listlist of objectsOptional

totalstringOptional