API Reference

Search geographic locations for targeting

get
https://api.vibe.co/geo/locations

Returns geographic locations available for strategy targeting. Provide type to browse all locations of a single type (with pagination). Provide search (min 2 chars) to search across all types. At least one of type or search is required. Scopes: campaigns:read
Rate limits:
Burst: 10/s
Steady: 300/m

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Filter by location type. When provided, search is optional and returns all rows of that type if omitted.

Allowed:
string
length ≥ 2

Case-insensitive label search (minimum 2 characters). Required when type is not provided. In fan-out mode (no type), offset is ignored and results span all location types.

number
1 to 100
Defaults to 20

Maximum number of results to return

number
≥ 0
Defaults to 0

Number of results to skip (single-type mode only)

boolean
Defaults to false

Include deprecated locations (REGION and CITY only). Defaults to false.

Responses

Updated 6 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago