Connections
List connection custom mappings
This endpoint returns a list of custom mappings for a connection.
get/vault/connections/{unified_api}/{service_id}/{resource}/custom-mappings
Path parameters
unified_apistring required
Unified API
service_idstring required
Service ID of the resource to return
resourcestring required
Name of the resource (plural)
Query parameters
resource_idstring
This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id.
Headers
x-apideck-consumer-idstring required
ID of the consumer which you want to get or push data from
x-apideck-app-idstring required
The ID of your Unify application
Response
Custom mapping
Example response
{
"status_code": 200,
"status": "OK",
"data": [
{
"id": "hris+employees+first_aid_training",
"label": "First Aid Training",
"description": "First Aid Training completed after 2019-01-01",
"value": "$.root.training.first_aid",
"key": "first_aid_training",
"custom_field": true,
"consumer_id": "test_user_id",
"example": "Some value"
}
]
}