Skip to main content
POST
Get mapping API detail

Restrictions

Usage

  • Returns data: null when no mapping API with this ID exists in the account.
  • A soft-deleted mapping API is still returned, with status = deleted.
  • Any caller in the account can read any mapping API. headers is returned in plain text only when the caller can edit the API (the account owner or an admin, the API’s creator, or a member of its team); otherwise it is null.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json
api_id
string
required

Mapping API ID (MongoDB ObjectID hex).

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

Mapping API configuration.