REST Mapping API

Updated by Wictor Stiebel

Quinyx ID Mapping API

The Quinyx mapping service is a Restfull API for managing connections between internal IDs in Quinyx with external id's used in other systems integrated with Quinyx.

Api-docs for rc : https://api-rc.quinyx.com/v2/docs

Api-docs : https://api.quinyx.com/v2/docs

The Mapping API cover the following scopes:

- Organisation

Access Rights

To be able to send requests to the Mapping API you need to add access rights for Mapping on your integration credentials in account settings:

GET /mappingTypes

This API returns all existing mapping types. Currently only Organisation types are supported. More types will be supported in the future

GET /mappingTypes/{mappingType}/mappings

List mapping types response based on specified domainid in the security token. and the mappingType specified as an id

Query parameters:

Use one of the following:

quinyxValue string

or

externalValue string

If both values are submitted an error will be returned

Response

The response will return a list with mapping objects if the request was successful

Example response

[{

"mappingType": "organisation",

"id": "112",

"quinyxValue": "112344",

"externalValue": "443211",

"domainId": 0

}]


How Did We Do?