Skip to main content
GET
/
api
/
entities
/
geo
List entity geo points for map rendering
curl --request GET \
  --url https://api.example.com/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
  }
}

Authorizations

Authorization
string
header
required

Auth0 JWT access token

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
string

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

Example:

"25"

offset
string
Example:

"0"

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

"-launch_year"

include_total
enum<string>
Available options:
true,
false
Example:

"true"

Response

List of geo points

data
object[]
required
page
object
required