List Companies

Details#

This endpoint returns all the companies, with pagination based on the parameters provided.

URL : /company

Method :

GET

Authentication

Auth is required to see disabled and blocked Companies, only Admins will see them. This also applies for the block admin reasons. Otherwise, (if in god mode) god_token must be provided.

Parameters#

god_token#

Body Parameter
Optional
String

If set, will use this for validating the usage of god mode (in case no session details are available, i.e., no logged-in user).

limit#

Query Parameter
Optional
Number

Default: 100
Maximum: 100

Limits the number of companies returned.

offset#

Query Parameter
Optional
Number

Default: 0
Minimum: 0

Number of companies to skip.

Response#

companies#

Response Field
Array

Array of objects containing the companies listed.

totalDocCount#

Response Field
Number

Number of companies listed.

Request examples#

Example 1 - Valid Request (Regular User)#

Code :

200 OK

/company/application/finish

Example 2 - Valid Request (Logged-in as Admin)#

Code :

200 OK

/company/application/finish
Edit this page