Skip to main content
GET
List Entity Field Mappings

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

entityTypeId
string

The entity type whose field mappings to list (required).

ingestionConfigId
string

Optionally narrow to mappings drawn from a single ingestion config.

Response

200 - application/json

Success

data
EntityFieldMapping · object[]

The field mappings for the entity type.