GET api/v1/businessgroups

List business group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Filter

Filter records

 ListBusinessGroupV1Filter

None.
Select

Select columns

 Collection of ListBusinessGroupV1Select

Default value: All

Example value: Name, Description

Unique items

Sort

Sort records Sort by the first column, then by the second column, and so on

 Collection of ListBusinessGroupV1Sort

Default value: Name

Example value: Name

Max items: 3

Unique items

PageNumber

Page number

 integer (32 bits)

Default value: 1

Example value: 1

Range: inclusive between 1 and 2147483647
PageSize

Number of records per page

 integer (32 bits)

Default value: 10

Example value: 10

Range: inclusive between 0 and 100

Body Parameters

None.

Response Information

Resource Description

Retrieve a list of business groups

ListBusinessGroupV1Response
NameDescriptionTypeAdditional information
BusinessGroups

List of business groups

 Collection of ListBusinessGroupV1ResponseBusinessGroup

None.
Total

Total number of records matching the request

 integer (32 bits)

Required

Example value: 42

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample: 
{
  "BusinessGroups": [
    {
      "BusinessGroupId": "b62f29ff-919a-4da7-8dfe-2655850c53d4",
      "Name": "Business Group",
      "Description": "Business Group",
      "Number": "BG1234",
      "CustomerId": "7d8afb70-79e8-44c0-a819-9ac742506452",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    },
    {
      "BusinessGroupId": "b62f29ff-919a-4da7-8dfe-2655850c53d4",
      "Name": "Business Group",
      "Description": "Business Group",
      "Number": "BG1234",
      "CustomerId": "7d8afb70-79e8-44c0-a819-9ac742506452",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    }
  ],
  "Total": 42
}