List Entity Mappings

View as Markdown
List every source-system to PaymentKit ID mapping for a migration. Returns the mappings created while the migration loaded data into PaymentKit, so you can resolve your original source IDs to PaymentKit IDs in bulk. Filter with `source_entity_type` to page one entity type at a time. Ordering is stable: rows sharing a `created_at` keep a deterministic relative order, so repeated calls at the same offset return the same rows. To page to completeness, pass `snapshot_at` and keep it constant across the whole run. Offset pagination is only consistent against a fixed row set — if the migration is still loading, newly created mappings enter the result set and shift the window, so a run without `snapshot_at` can miss or duplicate rows. With `snapshot_at` held constant, a full pass returns every mapping created at or before that instant exactly once, provided existing mappings are not deleted mid-run — the clamp bounds which rows enter the set, not which leave it.

Authentication

AuthorizationBearer

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

Path parameters

migration_idstringRequired

Migration ID (e.g., mig_dev_abc123)

account_idstringRequired

Query parameters

source_entity_typeenum or nullOptional
Filter by source entity type
snapshot_atdatetime or nullOptional

Only return mappings created at or before this timestamp (ISO 8601). Pass the same value on every page of a paging run to get a consistent snapshot: without it, mappings written by an in-flight migration shift the offset window and a full pass can miss or repeat rows. A value with no UTC offset is interpreted as UTC.

limitintegerOptional1-100Defaults to 50
Number of items per page
offsetintegerOptional>=0Defaults to 0
Number of items to skip
filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON string)

sortBystring or nullOptional
Field to sort by
sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Response

Successful Response
itemslist of objects
totalinteger
has_moreboolean

Errors

422
Unprocessable Entity Error