APappdirect
SegmentFolders

Read segment companies

Changed on

Returns a paginated list of all marketplace companies and indicates whether they are associated with the segment

get/channel/v1/segments/{companySegmentId}/availableAndAssociatedCompanies

Request

Path parameters

companySegmentIdstring required

Segment ID

Query parameters

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

selectedboolean

If true, returns only associated companies

Response

Success

Example response

{
  "content": [
    {
      "name": "Canada Company",
      "id": "04f8d043-10f1-4b89-8c0e-0780e5a62299",
      "selected": false
    },
    {
      "name": "US Company",
      "id": "04f8d043-10f1-4b89-8c0e-0780e5a62298",
      "selected": true
    }
  ],
  "page": {
    "number": 1,
    "size": 2,
    "totalElements": 10,
    "totalPages": 2
  }
}

Changes