---
title: "Get resource example"
method: GET
path: "/vault/connections/{unified_api}/{service_id}/{resource}/example"
tags: ["Connections"]
---

# Get resource example

`GET /vault/connections/{unified_api}/{service_id}/{resource}/example`

This endpoint returns a downstream example of a given resource.

## Path parameters

- `unified_api` string, required
- `service_id` string, required
- `resource` string, required

## Headers

- `x-apideck-consumer-id` string, required
- `x-apideck-app-id` string, required

## Response `200`

Resource Schema

- GetResourceExampleResponse
  - `status_code` integer, required — HTTP Response Status Code
  - `status` string, required — HTTP Response Status
  - `data` ResourceExample, required
    - `unified_api` 'accounting' | 'ats' | 'calendar' | 'crm' | 'csp' | 'customer-support' | 'ecommerce' | 'email' | 'email-marketing' | 'expense-management' | 'file-storage' | 'form' | 'hris' | 'lead' | 'payroll' | 'pos' | 'procurement' | 'project-management' | 'script' | 'sms' | 'spreadsheet' | 'subscription-analytics' | 'team-messaging' | 'issue-tracking' | 'time-registration' | 'transactional-email' | 'vault' | 'data-warehouse' — Name of Apideck Unified API
    - `service_id` string — Service provider identifier
    - `resource` LinkedConnectorResource
      - `id` string — ID of the resource, typically a lowercased version of name.
      - `name` string — Name of the resource (plural)
      - `status` 'live' | 'beta' | 'development' | 'upcoming' | 'considering' — Status of the resource. Resources with status live or beta are callable.
      - `downstream_id` string — ID of the resource in the Connector's API (downstream)
      - `downstream_name` string — Name of the resource in the Connector's API (downstream)
    - `example_response` object — Example response from the downstream API
  - `meta` Meta — Response metadata
    - `items_on_page` integer — Number of items returned in the data property of the response
    - `cursors` object — Cursors to navigate to previous or next pages through the API
      - `previous` string, nullable — Cursor to navigate to the previous page of results through the API
      - `current` string, nullable — Cursor to navigate to the current page of results through the API
      - `next` string, nullable — Cursor to navigate to the next page of results through the API
    - `total_count` integer — Number of records available in total for this resource
    - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200.
      - `type` string — Discriminator for the warning kind.
      - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available.
      - `error` string, nullable — Short error description from the downstream provider, when available.
      - `operation` string, nullable — Identifier of the workflow step that failed.
      - `message` string, nullable — Detailed message from the downstream provider, when available.
  - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `404` — The specified resource was not found
- `422` — Unprocessable
- `default` — Unexpected error

## Changes

- **2026-06-19** `97ecbbd22a2c` — 1 info
  - added the optional property `meta` to the response with the `200` status
- **2026-05-21** `0cfe9e28090c` — 1 warning
  - added the new `subscription-analytics` enum value to the `data/unified_api` response property for the response status `200`
- **2026-04-09** `79ff7820cc6f` — 1 warning, 1 info
  - removed the optional property `meta` from the response with the `200` status
  - removed the `subscription-analytics` enum value from the `data/unified_api` response property for the response status `200`

[Change history](https://skmtc.dev/apideck-libraries/apis/vault-api/changes/vault/connections/:unified_api/:service_id/:resource/example/get.md)

---

[API](https://skmtc.dev/apideck-libraries/apis/vault-api.md) · [All operations](https://skmtc.dev/apideck-libraries/apis/vault-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apideck-libraries/vault-api/revisions/fefba4c4b449/schema)