Skip to main content
POST
Create a list

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

The list's name. A name another list of the organization has is refused.

Required string length: 1 - 255
Example:

"Portugal freight ops"

type
enum<string>
default:people

What the list's rows are: people (the default) or companies. It cannot change later.

Available options:
people,
company

Response

The new list, empty.

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.

createdAt
string<date-time>
folderId
string

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