Skip to main content
GET
/
migration_mappings
List migration mappings
curl --request GET \
  --url https://api.synctera.com/v2/migration_mappings \
  --header 'Authorization: Bearer <token>'
{
  "migration_mappings": [
    {
      "creation_time": "2010-05-06T12:23:34.321Z",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "old_resource_id": "abc123",
      "old_tenant": "abcdef_ghijkl",
      "resource_id": "def456",
      "tenant": "abcdef_ghijkl",
      "deletion_time": "2010-05-06T12:23:34.321Z"
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
resource_id
string

Matches records where resource_id OR old_resource_id equals this value.

​
old_resource_id
string[]
​
resource_type
enum<string>[]

The type of resource being mapped.

Available options:
PERSON,
BUSINESS,
ACCOUNT
​
tenant
string[]

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

​
old_tenant
string[]

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

​
sort_by
enum<string>[]
Available options:
creation_time:asc,
creation_time:desc,
last_updated_time:asc,
last_updated_time:desc

Response

List of migration mappings

​
migration_mappings
object[]
required

Array of migration mappings.

​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"