Skip to main content
GET
List BYOK keys
List the keys of your workspace.
  • Disabled keys are included.
  • Credentials are masked as ********.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Sub-Account-ID
string<uuid>

Manage the keys of one sub-account instead of the workspace keys. See the Sub-accounts section of the BYOK overview.

Response

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

id
string<uuid>
required

The key ID.

Example:

"9f1c2d3e-4b5a-4c6d-8e7f-0a1b2c3d4e5f"

workspace_id
string<uuid>
required

The workspace that owns the key.

Example:

"2db5ea61-1752-42cf-8ea1-ab1da060cd0a"

provider
enum<string>
required

Provider identifier. Case-insensitive in requests; responses use lowercase.

Available options:
prospeo,
enrow,
cleon1,
datagma,
aviato,
wiza,
forager_ai,
icypeas,
contact_out,
people_data_labs,
lusha,
apollo_io,
zoominfo
Example:

"prospeo"

zone
enum<string>
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.

Available options:
front,
back,
auto
Example:

"front"

priority
integer
required

Order of the key in its zone. A lower value runs first.

Example:

10

data_types
enum<string>[]
required

Data types this key supplies.

Data type a key can supply.

Available options:
contact.work_emails,
contact.personal_emails,
contact.phones
Example:
verify
boolean
required

Whether FullEnrich verifies the values found with this key.

Example:

true

enabled
boolean
required

Whether the key is used in enrichments.

Example:

true

created_at
string<date-time>
required

When the key was created.

Example:

"2026-10-05T09:30:00Z"

updated_at
string<date-time>
required

When the key was last updated.

Example:

"2026-10-05T09:30:00Z"

credentials
object
required

The credential fields of the provider, with every value masked. Saved secrets are never returned.

sub_account_id
string<uuid>

The sub-account that owns the key. Omitted for a workspace key.

Example:

"70ff6a88-6291-417d-b6cd-04f1ca123470"