v1

latestOpenAPI 3.0.3Apache 2.02026-07-133681213.9 KB

Connections

Get resource custom fields

This endpoint returns an custom fields on a connection resource.

get/vault/connections/{unified_api}/{service_id}/{resource}/custom-fields

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

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "data": [
    {
      "id": "123456",
      "name": "SSN",
      "description": "Employee Level",
      "value": "495172776"
    }
  ]
}