--- title: "Get consumer" method: GET path: "/vault/consumers/{consumer_id}" tags: ["Consumers"] --- # Get consumer `GET /vault/consumers/{consumer_id}` Consumer detail including their aggregated counts with the connections they have authorized. ## Path parameters - `consumer_id` string, required ## Headers - `x-apideck-app-id` string, required ## Response `200` Consumer - GetConsumerResponse - `status_code` integer, required — HTTP Response Status Code - `status` string, required — HTTP Response Status - `data` Consumer, required - `consumer_id` string, required — Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID. - `application_id` string — ID of your Apideck Application - `metadata` ConsumerMetadata — The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended. - `account_name` string — The name of the account as shown in the sidebar. - `user_name` string — The name of the user as shown in the sidebar. - `email` string — The email of the user as shown in the sidebar. - `image` string — The avatar of the user in the sidebar. Must be a valid URL - `connections` ConsumerConnection[] - `id` string - `name` string - `icon` string - `logo` string - `website` string - `tag_line` string - `service_id` string - `unified_api` string - `consumer_id` string - `auth_type` 'oauth2' | 'apiKey' | 'basic' | 'custom' | 'none' — Type of authorization used by the connector - `enabled` boolean - `settings` object, nullable — Connection settings. Values will persist to `form_fields` with corresponding id - `metadata` object, nullable — Attach your own consumer specific metadata - `company_id` string — Normalized identifier of the authorized organization, copied from the connector-specific setting (e.g. Xero tenant_id, QuickBooks realm_id, NetSuite account_id). - `created_at` string - `updated_at` string, nullable - `state` 'available' | 'callable' | 'added' | 'authorized' | 'invalid' — [Connection state flow](#section/Connection-state) - `health` 'ok' | 'pending_refresh' | 'needs_auth' | 'pending_confirmation' | 'needs_consent' | 'revoked' | 'missing_settings' | 'degraded' — The operational health status of the connection - `credentials_expire_at` string, nullable — ISO 8601 timestamp indicating when credentials will be cleared if token refresh continues to fail. Only present when connection health is pending_refresh and a retention window is active. - `last_refresh_failed_at` string, nullable — ISO 8601 timestamp of the most recent token refresh failure. Only present when connection has experienced refresh failures. - `services` string[] - `aggregated_request_count` number - `request_counts` RequestCountAllocation - `unify` number - `proxy` number - `vault` number - `created` string - `modified` string - `request_count_updated` string - `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-07-07** `3f9c2f2b6d92` — 1 info - added the optional property `data/connections/items/metadata/company_id` to the response with the `200` status - **2026-06-19** `97ecbbd22a2c` — 1 info - added the optional property `meta` to the response with the `200` status - **2026-06-09** `3dc2f3a25b40` — 1 warning - added the new `degraded` enum value to the `data/connections/items/health` response property for the response status `200` - **2026-04-29** `cfde3408f527` — 1 warning - added the new `pending_confirmation` enum value to the `data/connections/items/health` response property for the response status `200` - **2026-04-09** `79ff7820cc6f` — 2 warning, 2 info - removed the optional property `data/connections/items/metadata/company_id` from the response with the `200` status - removed the optional property `meta` from the response with the `200` status - removed the `degraded` enum value from the `data/connections/items/health` response property for the response status `200` - removed the `pending_confirmation` enum value from the `data/connections/items/health` response property for the response status `200` [Change history](https://skmtc.dev/apideck-libraries/apis/vault-api/changes/vault/consumers/:consumer_id/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/0c8bcf1ce913/schema)