List BYOK Credentials

Returns a paginated list of BYOK credentials connected to your Zoice Dev account.

List BYOK Credentials API Documentation

This endpoint GET /v1/byok returns a list of all BYOK credentials connected to your account.

API Request

Sending Request

bash
curl -X GET "https://api.zoice.com/v1/byok" \
  -H "Authorization: Bearer $ZOICE_API_KEY"

Response Format

json
{
  "status": "success",
  "credentials": [
    {
      "credential_id": "cred_a8f7407278ce...",
      "provider": "elevenlabs",
      "key_name": "elevenlabs personal",
      "masked_api_key": "sk_4e75...682c",
      "key_status": "active"
    },
    {
      "credential_id": "cred_aad00e8e2446d...",
      "provider": "elevenlabs",
      "key_name": "elevenlabs business",
      "masked_api_key": "sk_2f75...682v",
      "key_status": "active"
    }
  ],
  "has_more": false,
  "next_page_token": null
}

Schemas

Input

Query Parameter

Type

Required

Default

Range

provider

string

No

-

elevenlabs

page_size

integer

No

10

1..100

next_page_token

string

No

-

-

Output

Field

Type

Description

status

string

The status of the API request.

Allowed values: "success", "processing", "failed"

credentials

object[]

Array containing available credential objects.

credentials[].key_status

string

The current status of the key.

Allowed values: "active", "expired", "disabled"

credentials[].credential_id

string

The unique identifier associated with the credential.

credentials[].key_name

string

The name of the credential.

credentials[].provider

string

The third-party provider associated with the credential, for eg., "elevenlabs".

credentials[].masked_api_key

string

The API key used to set up the credential in masked form.

has_more

boolean

The flag indicating whether more pages are available to query.

Allowed values: true, false

next_page_token

string | null

A string ID that can be passed as next_page_token in request to get the next page of credentials.