---
title: "List BYOK keys"
method: GET
path: "/providers"
---

# List BYOK keys

`GET /providers`

## Request

- Base URL: `https://app.fullenrich.com/api/v2`
- URL: `https://app.fullenrich.com/api/v2/providers`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/docs/providers/get.ts> (a function with typed inputs; its response is checked against the schema)

List the keys of the selected scope, including disabled keys, sorted by provider. Credentials are masked. A sub-account scope lists only the keys of that sub-account.

## Headers

- `Sub-Account-ID` string, uuid

## Response `200`

OK. An empty array when the scope has no key.

- BYOKKeyWithMaskedCredentials[]
  - `id` string, uuid, required: The key ID.
  - `workspace_id` string, uuid, required: The workspace that owns the key.
  - `sub_account_id` string, uuid: The sub-account that owns the key. Omitted for a workspace key.
  - `provider` 'prospeo' | 'enrow' | 'cleon1' | 'datagma' | 'aviato' | 'wiza' | 'forager_ai' | 'icypeas' | 'contact_out' | 'people_data_labs' | 'lusha' | 'apollo_io' | 'zoominfo' | 'cognism', required: Provider identifier. Case-insensitive in requests; responses use lowercase.
  - `zone` 'front' | 'back' | 'auto', required: Where the key runs in the waterfall. front: before the FullEnrich providers. back: after them. auto: at the position of the same provider in the FullEnrich waterfall.
  - `priority` integer, required: Order of the key in its zone. A lower value runs first.
  - `data_types` ProviderDataType[], required: Data types this key supplies.
  - `verify` boolean, required: Whether FullEnrich verifies the values found with this key.
  - `enabled` boolean, required: Whether the key is used in enrichments.
  - `created_at` string, date-time, required: When the key was created.
  - `updated_at` string, date-time, required: When the key was last updated.
  - `credentials` ProviderMaskedCredentials, required: The credential fields of the provider, with every value masked. Saved secrets are never returned.
    - `api_key` string
    - `account_id` string
    - `account_email` string
    - `personal_email_api_key` string
    - `client_id` string
    - `client_secret` string

## Other responses

- `401`: Unauthorized
- `403`: BYOK is not enabled for the workspace
- `404`: The sub-account named in the header does not exist, or is archived for a write request
- `429`: Too Many Requests

## Changes

- **2026-11-09** `b5bec9933c01`: 1 warning
  - added the new `cognism` enum value to the `items/allOf[#/components/schemas/BYOKKey]/provider` response property for the response status `200`
- **2026-11-05** `9e5fe5ba0794`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/changes/providers/get.md)

---

[API](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation.md) - [All operations](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/fullenrich/apis/fullenrich-api-documentation/revisions/b5bec9933c01?raw)