Skip to main content
GET
/
api
/
v1
/
companies
List companies
curl --request GET \
  --url http://localhost:3000/api/v1/companies \
  --header 'Authorization: Bearer <token>'
{
  "companies": [
    {
      "id": "comp_apple123",
      "name": "Apple Inc.",
      "slug": "apple-inc",
      "ticker_symbol": "AAPL"
    }
  ],
  "pagination": {
    "count": 1,
    "next_cursor": null
  }
}

Authorizations

​
Authorization
string
header
required

API Key authentication using Bearer token

Headers

​
Authorization
string
required

Bearer token for authentication

Query Parameters

​
limit
integer

Number of companies to return per page (default 25, max 100).

​
cursor
string

Opaque pagination cursor returned as pagination.next_cursor from a previous response. Mutually exclusive with q.

​
fields
string

Comma-separated list of fields to include in the response. Available fields: id, name, slug, ticker_symbol.

​
q
string

Full-text search query (2-200 characters). Searches company names and aliases. Results are ranked by relevance instead of alphabetical order. Mutually exclusive with cursor.

Response

200 - application/json

Companies retrieved successfully

​
companies
object[]
required
​
pagination
object