Skip to main content
POST
List mapping data

Restrictions

Usage

  • If query is provided, all source labels must be specified — partial source label queries are rejected.
  • Pagination uses cursor-based (search_after_ctx) or page-based (p, limit) navigation. limit defaults to 20, max 100.
  • The search_after_ctx token from a response can be passed back to retrieve the next page.

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json
schema_id
string
required

Mapping schema ID (MongoDB ObjectID hex).

query
object

Exact-match filter on source label values. Keys that are not source labels of the schema are silently ignored; if any source label is given, all source labels must be provided.

orderby
enum<string>

Sort field. Defaults to updated_at.

Available options:
created_at,
updated_at
asc
boolean

Sort ascending when true.

p
integer<int64> | null

Page number (1-based) for offset pagination; defaults to 1 when omitted, null, or 0. Ignored when search_after_ctx is set. Page-based navigation can reach at most 10,000 rows (p * limit <= 10000).

Required range: x >= 0
limit
integer<int64> | null

Page size (0–100); defaults to 20 when omitted, null, or 0.

Required range: 0 <= x <= 100
search_after_ctx
string | null

Opaque cursor for cursor-based pagination — pass the search_after_ctx value from the previous response. Must be a MongoDB ObjectID hex string; when set, p is ignored.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

Endpoint-specific payload. See each operation's 200 response schema.