v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Org Companies

Retrieves all companies of the org. Use filter parameters to get specific details.

get/companies/all

Query parameters

limitinteger

Number of results to relative.

status'ACTIVE' | 'INACTIVE'

Filter companies by status.

sortBy'createdDate'

Always sort results by created date.

sortOrder'asc' | 'desc'

Sort the results in ascending or descending order of the chosen soryBy.

offsetstring

Number of rows to be ignored from the top (pagination).

Response

200

Example response

{
  "pagination": {
    "limit": 100,
    "sortBy": "createdDate",
    "sortOrder": "DESC",
    "total": 3
  },
  "data": [
    {
      "externalId": "ppartner435",
      "companyId": 99,
      "name": "Purple Partner",
      "hierarchyDefinitionCode": "code-tst1111",
      "parentCompany": {
        "externalId": "Purple2345",
        "companyId": 98,
        "name": "Purple2346"
      },
      "isActive": true,
      "extendedFields": {
        "address1": "Richmond Circle",
        "owner": "James",
        "phone": "9988000000",
        "pincode": "560068"
      }
    }
  ]
}