Skip to main content
GET
Get a list

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Path Parameters

listId
string
required

The list's id.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Response

The list, with its own columns.

id
string
required
name
string
required
type
enum<string>
required

What the rows are: people or company.

Available options:
people,
company
rowCount
integer
required

The people or companies the list holds.

columns
object[]
required

The list's own columns. A row carries their values in columnValues, by column id.

folderId
string

The folder the list is in. Absent for a list in no folder.

status
string

processing while rows are still being added to the list, then complete. Absent when not known.

metrics
object

For a people list: how many of its people have each kind of contact data. Absent for a company list.