---
title: "Get all consumers"
method: GET
path: "/vault/consumers"
tags: ["Consumers"]
---

# Get all consumers

`GET /vault/consumers`

This endpoint includes all application consumers, along with an aggregated count of requests made.

## Query parameters

- `filter` ConsumersFilter
  - `consumer_id` string, nullable — Filter by consumer ID using a prefix match (beginsWith).
  - `search` string, nullable — Search across consumer ID, email, account name, and user name using a substring match (contains). Matches any field (OR logic).
- `cursor` string, nullable
- `limit` integer

## Headers

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

## Response `200`

Consumers

- GetConsumersResponse
  - `status_code` integer, required — HTTP Response Status Code
  - `status` string, required — HTTP Response Status
  - `data` object[], required
    - `consumer_id` string
    - `application_id` string
    - `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
    - `aggregated_request_count` number
    - `request_counts` RequestCountAllocation
      - `unify` number
      - `proxy` number
      - `vault` number
    - `created` string
    - `modified` string
    - `request_count_updated` string
    - `services` 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.
  - `links` Links — Links to navigate to previous or next pages through the API
    - `previous` string, nullable — Link to navigate to the previous page through the API
    - `current` string — Link to navigate to the current page through the API
    - `next` string, nullable — Link to navigate to the previous page through the API
  - `_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

---

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