Skip to content
getgeolens.com
GeoLens Docs

List Maps Endpoint

GET
/maps/
 
curl --request GET \
  --url 'https://example.com/maps/?skip=0&limit=50&sort_by=name&sort_dir=asc&owned_only=false'

List maps. Admins see all; authenticated users see own + internal + public + restricted maps shared with their groups; anonymous see public only.

Supports search (ILIKE on name+description), sort_by (name/created_at/updated_at), sort_dir (asc/desc), and visibility filter (private/internal/public/restricted). owned_only restricts results to the caller’s maps; anonymous callers get no maps.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
skip
Skip
integer
0
limit
Limit
integer
default: 50 >= 1 <= 200
search
Any of:
string
sort_by
Sort By
string
default: updated_at
Allowed values: name created_at updated_at
sort_dir
Sort Dir
string
default: desc
Allowed values: asc desc
visibility
Any of:
string
owned_only
Owned Only
boolean

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
MapListResponse
object
maps
required
Maps
Array<object>
MapSummaryResponse
object
id
required
Id
string format: uuid
name
required
Name
string
description
required
Any of:
string
visibility
required
MapVisibility

Who may read a map. A response names restricted only to a client that sends X-GeoLens-Map-Visibility: restricted; any other client reads a restricted map as private.

string
Allowed values: private internal public restricted
thumbnail_url
Any of:
string
thumbnail_updated_at
Any of:
string format: date-time
layer_count
required
Layer Count
integer
created_by_username
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
created_by
Any of:
string format: uuid
total
required
Total
integer

Example 

{
  "maps": [
    {
      "visibility": "private"
    }
  ]
}

400

Section titled “ 400 ”

Bad request — invalid payload

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Section titled “ 401 ”

Unauthorized — missing or invalid credentials

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Section titled “ 403 ”

Forbidden — caller lacks access to this resource

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Section titled “ 404 ”

Not found

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

409

Section titled “ 409 ”

Conflict — resource state prevents the operation

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Section titled “ 422 ”

Validation error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Section titled “ 429 ”

Too many requests — retry after the advertised interval

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Section titled “ Headers ”
Retry-After
integer

Seconds until the request may be retried

500

Section titled “ 500 ”

Internal server error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Section titled “ 503 ”

Service unavailable — the database could not serve the request

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}
Privacy Apache 2.0 getgeolens.com