Contact Secrets

List Contact Secrets

List contact secrets

get
/v1/contact/{contactId}/secret/list

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

contactIdstring* Required

The ID of the contact to list secrets for

cursorstring

The cursor to use for pagination

orderstring

The order of the paginated items

takeinteger

The number of items to retrieve

import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({

secret: process.env.CHATBOTKIT_API_KEY!

})

const response = await cbk.contact.secret.list(

contactId
)
{
"items":[
{
"name":"string",
"description":"string",
"meta":"object",
"id":"string",
"createdAt":"number",
"updatedAt":"number",
"type":"string"
}
]
}
The list of contacts was retrieved successfully