Contact Spaces

List Contact Spaces

List contact spaces

get

/v1/contact/{contactId}/space/list

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

contactIdstring* Required

The ID of the contact to list spaces 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.space.list(
contactId
)

{"items":[{"name":"string",
"description":"string",
"meta":"object",
"id":"string",
"createdAt":"number",
"updatedAt":"number",
"contactId":"string"
}
]
}

The list of contacts was retrieved successfully

Go to cbk.ai