Skip to main content
GET
/
api
/
entities
/
geo
List entity geo points for map rendering
curl --request GET \
  --url https://api-next.dealroom.co/api/entities/geo \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "lat": 123,
      "lon": 123,
      "hq_country": "<string>",
      "hq_city": "<string>"
    }
  ],
  "page": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.beta.dealroom.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token. Paste a token obtained from your preferred OAuth2 flow. For machine-to-machine use, the OAuth2 client_credentials scheme below can mint a token directly from your client_id / client_secret inside the Swagger UI Authorize dialog.

Query Parameters

​
filter
string

Filter expression for geo points (same syntax as entity list).

Examples:

  • Single: is_company[eq]:true
  • AND: and(is_company[eq]:true,location_country[eq]:USA)

Operators: eq, neq, gt, gte, lt, lte, in_any, nin_any

Example:

"and(is_company[eq]:true,location_state[eq]:New York)"

​
limit
integer<int32>
default:25

Number of results to return (1-5000, default 25)

Required range: 1 <= x <= 5000
Example:

25

​
offset
integer<int32>
default:0

Number of results to skip before returning data. Combine with limit for offset-based pagination.

Required range: x >= 0
Example:

0

​
cursor
string

Opaque cursor token from a previous response's page.next_cursor or page.prev_cursor. Round-trip it as-is — do not decode or modify.

Example:

"eyJ2IjoxLCJkIjoibmV4dCJ9"

​
sort
string

Sort by one or more keys. Prefix with - for descending order; comma-separated for multi-key sorts.

Pattern: ^-?[\w,]+$
Example:

"-launch_date"

​
include_total
boolean

Pass true to include page.total (the matching record count) in the response. Default omits the total to avoid a count query.

Example:

true

​
currency
string

ISO 4217 currency code for monetary field conversion. Defaults to USD.

Example:

"EUR"

Response

List of geo points

​
data
object[]
required
​
page
object
required