APappdirect
SegmentFolders

Read segments

Changed on

Returns a paginated list of segments

get/channel/v1/segments

Request

Query parameters

companyGroupIdstring required

Segment folder ID

numberinteger

Page number

sizeinteger

Number of results per page

sortstring

Sort field and order. For ascending sort order, use the '+[FieldName]' format. For descending order, use the '-[FieldName]' format.

searchTextstring

Search text

Response

OK

Example response

{
  "content": [
    {
      "id": "9f4e5c52-5258-4193-a132-303f06e9eef1",
      "name": "Canada",
      "partner": "APPDIRECT",
      "code": "CAN",
      "type": "MANUAL"
    },
    {
      "id": "b1f5af35-ca68-431f-83b7-ef56189924ed",
      "name": "France",
      "partner": "APPDIRECT",
      "code": "FRA",
      "type": "MANUAL"
    },
    {
      "id": "5ca15227-da6b-413e-a09c-f8d06ab3dcd7",
      "name": "United States",
      "partner": "APPDIRECT",
      "code": "USA",
      "type": "MANUAL"
    }
  ],
  "page": {
    "number": 0,
    "size": 50,
    "totalElements": 3,
    "totalPages": 1
  }
}

Changes