Skip to content
getgeolens.com
GeoLens Docs

List Share Tokens Endpoint

GET
/admin/share-tokens/
 
curl --request GET \
  --url 'https://example.com/admin/share-tokens/?skip=0&limit=50&sort=map_name&order=asc' \
  --header 'Authorization: Bearer <token>'

List basic share-token inventory with map info; no quotas or domain controls (admin only).

sort and order are closed enums, so an unrecognised value is refused with a 422 and never reaches the query.

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
<= 200 characters
status
Any of:
string
/^(active|expired|revoked)$/
sort
Sort

Column to order by. Link status is not sortable: it is derived from is_active and expires_at after the query returns.

string
default: created_at
Allowed values: map_name created_at creator expires_at embed_token_count

Column to order by. Link status is not sortable: it is derived from is_active and expires_at after the query returns.

order
Order

Sort direction.

string
default: desc
Allowed values: asc desc

Sort direction.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
AdminShareTokenListResponse
object
tokens
required
Tokens
Array<object>
AdminShareTokenResponse
object
id
Any of:
string format: uuid
map_id
required
Map Id
string format: uuid
map_name
required
Map Name
string
token
Any of:
string
is_active
Any of:
boolean
expires_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
created_by
required
Any of:
string
embed_token_count
Embed Token Count
integer
0
total
required
Total
integer
Example 
{
  "tokens": [
    {
      "embed_token_count": 0
    }
  ]
}

400

Section titled “400 ”

Bad request — invalid query parameters or 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"
}

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