List Contacts in a Contact List
Returns one bounded page of logical Contacts in the List. Existing physical duplicate rows are collapsed before membership is evaluated.
OpenAPI
````yaml get /api/v2/contact/list/{listName}
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/contact/list/{listName}:
get:
tags:
- Contacts
summary: List Contacts in a Contact List
description: >-
Returns one bounded page of logical Contacts in the List. Existing
physical duplicate rows are collapsed before membership is evaluated.
parameters:
- name: listName
in: path
required: true
schema:
type: string
- name: page
in: query
description: Page number starting at 1. Defaults to 1.
schema:
type: integer
- name: pageSize
in: query
description: Page size. Defaults to 20 and is capped at 100.
schema:
type: integer
- name: sort
in: query
description: updatedAt, createdAt, id, name, email, or phone.
schema:
type: string
- name: order
in: query
description: asc or desc.
schema:
type: string
responses:
default:
description: ''
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
