Skip to main content
POST
Add Item To Lists

Authorizations

Authorization
string
header
required

Enter your API key

Query Parameters

user_id
string
required

Body

application/json

Request model for adding an item to multiple lists

list_ids
string[]
required

List of target list IDs to add the item to

Minimum array length: 1
item_data
ListItemBase ยท object
required

Data for the item to be added

Response

Successful Response

Response model for a list item with metadata

entity_id
string
required

ID of the entity (company or person)

entity_name
string
required

Name of the entity

id
string
required

Unique identifier for the list item

created_at
string
required

ISO timestamp when the item was created

updated_at
string
required

ISO timestamp when the item was last updated

is_company
boolean
default:true

Whether the entity is a company (True) or person (False)

register_number
string | null

Company register number (for companies)

birth_date
string | null

Birth date (for persons)

notes
string | null

Additional notes about the entity

watchlist_subscription_id
string | null

ID of associated watchlist subscription if applicable