Skip to main content
GET
Get specific mapping

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

identifier
string
required
read-only

Mapping's identifier Uniquely identify a mapping.

Example:

"mEFayXdO"

Response

Successfully retrieved mapping.

A mapping allows you to specify specific settings regarding a lookup against a MappingDataSource should be applied.

identifier
string
required
read-only

Uniquely identify a mapping.

Example:

"mEFayXdO"

dataSource
string | null
required

The mapping data source this mapping applies to.

Example:

"mewERBRJJ"

organization
string | null

The organization that this mapping belongs to.

Example:

"mewlkWEKL"

scoreCutoff
number | null

Higher values will result in more strict matching.

Example:

10

orderBy
string | null

The field to order the results by. Leave blank for ordering by relevance.

Example:

"label"