Docs

Get Import Mappings

GET /importMappings?target=proposalLineItems

GET/importMappings?target=proposalLineItems

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Event tokenx-Event-TokenOptionalRun **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. Required for the `proposalLineItems` target.
Organization tokenx-Organization-TokenOptionalRun **Get Tokens** in the **Organization API** collection, then set `orgToken` as a variable here. Required for the `events` target instead of the event token.

Every saved column mapping for one import target, so a recurring file can be mapped once and reused.

The permission is the target's, not this endpoint's — EventAdmin for proposalLineItems, OrganizationAdmin for events. See Get Import Mappings (Events).

Parameters

FieldTypeRequiredDescription
targetstringRequiredQuery. The import target, matched case-insensitively — `proposalLineItems` or `events`.

Response

[
  {
    "id": "0198f2c1-...",
    "target": "ProposalLineItems",
    "name": "Monthly Ticketing Export",
    "isDefault": true,
    "configuration": "{\"contextId\":null,\"uniqueAttributeKey\":null,\"columns\":[...]}"
  }
]
FieldTypeDescription
idGuid
targetstringThe canonical target name, so `?target=events` returns rows reading `Events`.
namestring
isDefaultboolAt most one mapping per target per organization carries this. A client applies it automatically when a file is uploaded for that target.
configurationstring**Opaque to this API.** The client owns the shape — the column mappings, the chosen unique attribute, and the context the mapping was built against. Nothing here parses or validates it, and it is returned byte for byte as it was saved.

Scope — a mapping is organization-wide, whatever its target's scope is

A mapping describes column shape, so it deliberately outlives the event any one import ran on. A proposalLineItems mapping saved while working on one event is returned when listing from any event in the same organization — which is the whole point, because next month's recurring file lands on a different event.

Mappings are shared at their scope rather than owned by a user, the same way saved views are. Everyone who can reach the target sees the same list.

Applying a stale mapping

A mapping stores attribute keys, and an attribute can stop resolving — it was renamed or deleted, or its kind stopped being importable. The mapping is still returned in full: the client applies every mapping that still resolves against the current schema and flags the rest.

Loading never rewrites the stored configuration, so an attribute restored next week makes the mapping whole again. That is why this endpoint returns the raw blob rather than a pre-resolved one.

Errors

StatusMeaning
400target is missing or is not a registered import target.
403The caller lacks the target's declared permission.