v1

latestOpenAPI 3.0.3Apache 2.02026-07-133681213.9 KB
Connections

Get consent records

Get all consent records for a connection

get/vault/connections/{unified_api}/{service_id}/consent

Path parameters

service_idstring required

Service ID of the resource to return

unified_apistring required

Unified API

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

Consent records

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": "con_1234567890",
      "created_at": "2025-04-15T14:30:00Z",
      "granted": true,
      "resources": {
        "hris.employees": {
          "id": {
            "read": true,
            "write": false
          },
          "first_name": {
            "read": true,
            "write": true
          },
          "last_name": {
            "read": true,
            "write": true
          },
          "email": {
            "read": true,
            "write": true
          },
          "addresses[].street": {
            "read": true,
            "write": false
          },
          "addresses[].city": {
            "read": true,
            "write": false
          },
          "employment.job_title": {
            "read": true,
            "write": true
          },
          "custom_fields[].employee_number": {
            "read": true,
            "write": false
          }
        },
        "hris.departments": {
          "id": {
            "read": true,
            "write": false
          },
          "name": {
            "read": true,
            "write": true
          },
          "code": {
            "read": true,
            "write": false
          }
        }
      }
    }
  ]
}