Skip to content
OpenGTM

Search Companies

GET
/api/ambitionbox/companies
curl --request GET \
  --url 'http://localhost:8000/api/ambitionbox/companies?page=1&limit=20&sort_by=popular' \
  --header 'Authorization: Bearer <token>'

Search AmbitionBox companies with filters.

Query params: page: Page number (1-indexed) limit: Results per page sort_by: popular | rating | reviews industry: Comma-separated. e.g. “IT Services & Consulting,Banking” location: Comma-separated. e.g. “Bangalore/Bengaluru,Mumbai” company_type: Comma-separated. e.g. “Public,Private” rating: Min rating. e.g. “3.5”

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
Page
integer
default: 1 >= 1
limit
Limit
integer
default: 20 >= 1 <= 20
sort_by
Sort By
string
default: popular
industry
Any of:
string
location
Any of:
string
company_type
Any of:
string
rating
Any of:
string

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}