List object
A workspace list of saved people or saved companies. Any member of the workspace can read, rename or delete any of its lists. An answer can also carry owner.email (sent to workspace admins only) and owner.profile_photo: both are deprecated and will be removed, so do not rely on them.
List
| Property | Type | Description |
|---|---|---|
id | string | The list id (24 hex characters). |
name | string | Display name, unique per type within the workspace (case-insensitive). |
type | enum | What a list holds: people (saved people) or companies (saved companies). Fixed at creation. One of: people, companies. |
records_count | integer | Records in the list, counted at read time as an export of the list would write them. 0 in the answer to a create. |
last_added_record_at | string | null | When a record was last added to the list; null when none ever was. |
created_at | string | When the list was created. |
updated_at | string | When the list last changed: renamed, or a record added to it. |
owner | object | null | Who created the list; null when that is not recorded. |
Owner fields (within owner)
A workspace member, as named on what they created (owner). Carries no email.
| Property | Type | Description |
|---|---|---|
id | string | The user id. |
first_name | string | null | |
last_name | string | null | |
photo_url | string | null | Profile photo URL; null without one. |