Sign in
External Mapping

List External Mappings for External Entity

Retrieve a list of External Mapping entities for a specified external system entity.

Use this endpoint to retrieve a list of External Mapping entities associated with a specific external system entity. The list can be paginated for easier management.

get/organizations/{orgId}/externalmappings/externalid/{system}/{externalTable}/{externalId}

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

systemstring required

The identifier for the external system.

externalTablestring required

The identifier for the external table.

externalIdstring required

The unique identifier (UUID) for the external entity.

Query parameters

pageSizeinteger

Specifies the maximum number of External Mappings to retrieve per page.

nextTokenstring

The nextToken for multi-page retrievals. It is used to fetch the next page of External Mappings in a paginated list.

Response

Returns the list of External Mapping entities for the external entity

nextTokenstring

Example response

{
  "data": [
    {
      "m3terEntity": "Account",
      "m3terId": "00000000-0000-0000-0000-000000000000",
      "externalSystem": "Stripe",
      "externalTable": "Customer",
      "externalId": "cus_00000000000000",
      "integrationConfigId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

Changes

Changed in 2 of the 10 revisions of this API.222

  • 9f9e5f3dbde712See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the optional property data to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property nextToken to the response with the 200 status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b512See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      removed the optional property data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property nextToken from the response with the 200 status

      response-optional-property-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog