GET all Company Groups

Getting list of the company groups limited by 2 parameters "limit" and "skip". To get the whole list, please set limit=0 and skip=0 (Resource URI: 'companyGroups/0/0')

Resource URI

companyGroups/{limit}/{skip}

Resource Properties

Parameter	Description
limit	It limit the search. Default is 50. Eg. companyGroups/50/0
skip	Offset of next page result. Default is 0. Eg. companyGroups/50/0

Response Attribute

{
    count: Integer,
    data: [
        {
            company_group_name: String,
            company_group_record_established: String,
            _id: String,
            company_group_aliases: Array,
            company_count: Integer,
            companies: [
                company: String
            ],
            project_count: Integer,
        }
    ]
}

HTTP GET

Default Request

curl -GET http://end-point-uri/companyGroups/50/0

Response

HTTP Status Code 200

{
    count: 63,
    data: [
        {
            company_group_name: "African Petroleum",
            company_group_record_established: "56fcd406be65cd01000bdca8",
            _id: "56fcd406be65cd01000bdcb1",
            company_group_aliases: [ ],
            company_count: 1,
            companies: [
                company: "56fcd407be65cd01000bdcc5"
            ],
            project_count: 0,
        },
        ...
    ]
}