List mapping templates.

GET

/api/admin/field-mapping/templates

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/field-mapping/templates \
  --header 'Authorization: Bearer <token>'

Lists reusable field-mapping templates for the tenant, including template key, scope, display name, template payload, and lifecycle state.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Mapping template list response.

Media type application/json

object

templates

required

Array<object>

object

id

required

string

tenantId

required

string

templateKey

required

string

templateScope

required

string

displayName

required

string

template

required

object

key

additional properties

lifecycleState

required

string

key

additional properties

key

additional properties

Example ^generated

{
  "templates": [
    {
      "id": "example",
      "tenantId": "example",
      "templateKey": "example",
      "templateScope": "example",
      "displayName": "example",
      "template": {
        "additionalProperty": "example"
      },
      "lifecycleState": "example"
    }
  ]
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}