Find Segments | Virtuous Developer Documentation

{
  "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.

Query parameters

skipintegerOptional

How many items to skip.

takeintegerOptional

How many items to take.

Request

This endpoint expects an object.

searchstringOptional

Response

listlist of objectsOptional

totalstringOptional

Errors

400

Bad Request Error