Connections

Get resource example

This endpoint returns a downstream example of a given resource.

get/vault/connections/{unified_api}/{service_id}/{resource}/example

Path parameters

unified_apistring required

Unified API

service_idstring required

Service ID of the resource to return

resourcestring required

Name of the resource (plural)

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

Resource Schema

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": {
    "unified_api": "crm",
    "service_id": "close",
    "resource": {
      "id": "companies",
      "name": "Companies",
      "downstream_id": "accounts",
      "downstream_name": "Accounts"
    }
  },
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  }
}

Changes

Changed in 3 of the 66 revisions of this API.22

Jun 19, 202697ecbbd22a2c1See the full diff
- ○
  added the optional property meta to the response with the 200 status
  response-optional-property-added
May 21, 20260cfe9e28090c1See the full diff
- ●
  added the new subscription-analytics enum value to the data/unified_api response property for the response status 200
  response-property-enum-value-added
Apr 9, 202679ff7820cc6f11See the full diff
- ●
  removed the optional property meta from the response with the 200 status
  response-optional-property-removed
- ○
  removed the subscription-analytics enum value from the data/unified_api response property for the response status 200
  response-property-enum-value-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history