List maps

GET

/v1/projects/{id}/maps

• Web API (Projects, Maps, Content, Query, Analytics, Alerts, Data)

Returns all maps for the specified project, ordered by creation date (newest first).

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Project UUID.

Responses

200

List of maps.

object

success

boolean

data

Array<object>

object

id

Internal UUID primary key.

string format: uuid

name

Display name of the map.

string

mapId

User-specified map identifier.

string

imageUrl

URL path to the map image.

string

worldMinX

number

worldMinY

number

worldMaxX

number

worldMaxY

number

worldMinZ

number | null

worldMaxZ

number | null

imageWidth

integer

imageHeight

integer

createdAt

string format: date-time

updatedAt

string format: date-time

Headers

X-RateLimit-Limit

integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining

integer

Number of requests remaining in the current window.

X-RateLimit-Reset

integer

Unix timestamp when the rate limit window resets.

401

Missing or invalid API key.

RFC 9457 Problem Details. Served with the application/problem+json media type. error_category, retryable, and retry_after are Framedash extension members. type always defaults to about:blank, so it is always present; detail and the extension members are present only when applicable.

object

type

required

Problem type URI; about:blank when no specific type applies.

string format: uri

default: about:blank

title

required

Short, human-readable summary of the problem type.

string

status

required

HTTP status code.

integer

detail

Human-readable explanation specific to this occurrence.

string

error_category

Extension member categorizing the error.

string

Allowed values: authentication authorization validation rate_limit not_found conflict payload internal

retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean

retry_after

Extension member; suggested retry delay in seconds, when applicable.

integer

429

Rate limit exceeded.

RFC 9457 Problem Details. Served with the application/problem+json media type. error_category, retryable, and retry_after are Framedash extension members. type always defaults to about:blank, so it is always present; detail and the extension members are present only when applicable.

object

type

required

Problem type URI; about:blank when no specific type applies.

string format: uri

default: about:blank

title

required

Short, human-readable summary of the problem type.

string

status

required

HTTP status code.

integer

detail

Human-readable explanation specific to this occurrence.

string

error_category

Extension member categorizing the error.

string

Allowed values: authentication authorization validation rate_limit not_found conflict payload internal

retryable

Extension member; true when retrying may succeed (e.g. 429, 503).

boolean

retry_after

Extension member; suggested retry delay in seconds, when applicable.

integer

Headers

X-RateLimit-Limit

integer

Maximum number of requests allowed per hour.

X-RateLimit-Remaining

integer

Number of requests remaining in the current window.

X-RateLimit-Reset

integer

Unix timestamp when the rate limit window resets.

Retry-After

integer

Number of seconds to wait before retrying. Present only on 429 responses. Because the limit uses a sliding window, honor this value per response rather than scheduling a retry for the reset time.