OpenAPI 3.1.0: API Reference

Creates a new contact. First name and last name are required. All other fields are optional.

Creates many contacts in a single request. Each contact requires first name and last name. All other fields are optional.

Deletes a contact from the database.

Deletes many contacts by their id (UUID, email/phone, or provider:value handle) in a single request. This operation cannot be undone.

Retrieves a single contact by its unique identifier.

Retrieves configuration for contacts API, including available custom columns, filterable fields, and sortable fields.

Retrieves a list of contacts with optional filtering, sorting, and pagination.

Updates an existing contact. Only provided fields are updated. Set fields to null to clear them.

Updates many contacts in a single request. Each contact is addressed by id (the contact UUID, an email or phone, or 'provider:value' for a handle). All other fields are optional.

Sent when a contact is created.

Sent when a contact is deleted.

Sent when a contact is updated.

Creates many organizations in a single request. Each organization requires a name. All other fields are optional.

Creates a new organization. Name is required. All other fields are optional.

Deletes many organizations by their IDs in a single request. This operation cannot be undone.

Deletes an organization from the database.

Retrieves a single organization by its unique identifier.

Retrieves configuration for organizations API, including available custom columns, filterable fields, and sortable fields.

Retrieves a list of organizations with optional filtering, sorting, and pagination.

Updates many organizations in a single request. Each organization requires an ID. All other fields are optional.

Updates an existing organization. Only provided fields are updated. Set fields to null to clear them.

Sent when an organization is created.

Sent when an organization is deleted.

Sent when an organization is updated.

Creates a new deal. Name is required. All other fields are optional.

Creates many deals in a single request. Each deal requires a name. All other fields are optional. Deals can include services with quantities using the services array.

Deletes a deal from the database.

Deletes many deals by their IDs in a single request. This operation cannot be undone.

Retrieves a single deal by its unique identifier.

Retrieves configuration for deals API, including available custom columns, filterable fields, and sortable fields.

Retrieves a list of deals with optional filtering, sorting, and pagination.

Updates an existing deal. Only provided fields are updated. Set fields to null to clear them.

Updates many deals in a single request. Each deal requires an ID. All other fields are optional. You can update services by providing a services array with serviceId and quantity.

Sent when a deal is created.

Sent when a deal is deleted.

Sent when a deal is updated.

Creates many services in a single request. Each service requires a name and an amount (must be greater than 0). All other fields are optional.

Creates a new service. Name and amount are required. All other fields are optional.

Deletes many services by their IDs in a single request. This operation cannot be undone.

Deletes a service from the database.

Retrieves a single service by its unique identifier.

Retrieves configuration for services API, including available custom columns, filterable fields, and sortable fields.

Retrieves a list of services with optional filtering, sorting, and pagination.

Updates many services in a single request. Each service requires an ID. All other fields are optional.

Updates an existing service. Only provided fields are updated. Set fields to null to clear them.

Sent when a service is created.

Sent when a service is deleted.

Sent when a service is updated.

Creates many tasks in a single request. Each task requires a name. All other fields are optional.

Creates a new task. Name is required. All other fields are optional.

Deletes many tasks by their IDs in a single request. This operation cannot be undone.

Deletes a task from the database.

Retrieves a single task by its unique identifier.

Retrieves configuration for tasks API, including available custom columns, filterable fields, and sortable fields.

Retrieves a list of tasks with optional filtering, sorting, and pagination.

Updates many tasks in a single request. Each task requires an ID. All other fields are optional.

Updates an existing task. Only provided fields are updated. Set fields to null to clear them.

Sent when a task is created.

Sent when a task is deleted.

Sent when a task is updated.

Retrieves the authenticated user's profile information.

Retrieves a list of users with optional filtering, sorting and pagination.

Accepts a received relation request by invitationId on a connected LinkedIn or Instagram account. Requires a connected LinkedIn or Instagram account.

Returns the leads (kind leads, default) or accounts (kind accounts) saved in a Sales Navigator list of a connected LinkedIn account, page by page (offset pagination).

Withdraws or refuses a relation request by invitationId on a connected LinkedIn or Instagram account. Requires a connected LinkedIn or Instagram account.

Sends a real connection / relation request from a connected LinkedIn or Instagram account to identifier, with an optional short message. Requires a connected LinkedIn or Instagram account.

Subscribes an endpoint to the given events (url and events are required). Deliveries are signed with HMAC-SHA-256 in the X-Webhook-Signature header when a secret is set. The signing secret is never returned. Providing an existing id updates that subscription instead.

Removes a webhook subscription so it stops receiving deliveries.

Deletes a draft message by its id. Only draft messages can be discarded; sent messages are unaffected.

Retrieves the activity timeline (messages, audit-log changes, calendar events) for the workspace or one record, with optional scoping to a single entity, sorting, and pagination.

Fetches one calendar of a connected account visible to the caller, or null when no calendar with this id is accessible. The id matches the entityId of the messaging.calendar.changed webhook event.

Fetches one calendar event visible to the caller, including organizer and attendees, or null when no event with this id is accessible. The id matches the entityId of the messaging.calendar.event.changed webhook event.

Retrieves calendar events visible to the caller, ordered by start time, with optional filtering (calendarId, connectedAccountId, startsAt date range), sorting, and pagination. Event ids match the entityId of the messaging.calendar.event.changed webhook event.

Retrieves the calendars of connected accounts visible to the caller (own accounts plus shared ones), with optional filtering (connectedAccountId), search, sorting, and pagination. Calendar ids match the entityId of the messaging.calendar.changed webhook event.

Lists the messaging accounts connected to the workspace and visible to the authenticated user.

Fetches one message thread with its full message list. Returns the thread plus each message's direction, sender, subject, text body, and attachment metadata (HTML bodies and raw attachment urls are omitted).

Retrieves a list of inbox message threads with optional search, sorting, and pagination.

Reads engagement on a social post: kind=comments (default) lists the post's comments, kind=reactions lists who reacted to the post, or set commentId to list reactions on that specific comment (kind is ignored). Requires a connected LinkedIn or Instagram account.

Reads LinkedIn or Instagram posts from a connected account. Omit postId to list an author's posts (authorIdentifier defaults to the account holder); set postId to fetch one post. Requires a connected LinkedIn or Instagram account.

Reads a LinkedIn or Instagram profile by identifier from a connected account. On LinkedIn the identifier is the public identifier or a provider member id (use 'me' for the account owner); on Instagram it is the username. Requires a connected LinkedIn or Instagram account.

Returns one webhook subscription by ID. The signing secret itself is never returned.

Lists the connection / relation requests received by the owner of a connected LinkedIn or Instagram account. Requires a connected LinkedIn or Instagram account.

Lists the Sales Navigator lead lists (kind leads, default) or account lists (kind accounts) of a connected LinkedIn account. Lists can only be created in the Sales Navigator UI; the API reads and fills existing lists.

Resolves the parameter ids used by the Sales Navigator people and company search filters. Pass a type (LOCATION, INDUSTRY, JOB_TITLE, COMPANY, LEAD_LIST, ACCOUNT_LIST and more) and optional keywords to look up matching ids with display names. LEAD_LIST and ACCOUNT_LIST also resolve existing list ids by name.

Saves or updates the draft reply on a thread for the current user to review and send from the inbox. Local only; nothing is delivered. subject, cc, and bcc apply to email threads. There is one draft per thread; saving again replaces it.

Saves a person (kind leads, providerId is the LinkedIn user id) or a company (kind accounts, providerId is the LinkedIn company id) to an existing Sales Navigator list on a connected LinkedIn account. New lists must be created in the Sales Navigator UI first.

Runs a structured LinkedIn Sales Navigator company search through a connected LinkedIn account. Filters take parameter ids resolved via the search-parameters endpoint (location, industry, account lists) plus native ranges like headcount, annual revenue and spotlights. Returns company rows page by page (offset pagination, LinkedIn caps a single company search at 1000 results). Requires the connected account to have a Sales Navigator subscription.

Executes a LinkedIn Sales Navigator search from a pasted search URL through a connected LinkedIn account and returns the result rows page by page (offset pagination). Requires the connected account to have a Sales Navigator subscription.

Runs a structured LinkedIn Sales Navigator people search through a connected LinkedIn account. Filters take parameter ids resolved via the search-parameters endpoint (location, industry, company, job title, and more) plus native enums like seniority and company headcount. Returns lead rows page by page (offset pagination, LinkedIn caps a single search at 2500 results). Requires the connected account to have a Sales Navigator subscription.

Sends a real message into an existing chat thread (LinkedIn, WhatsApp, etc.). This delivers a real message as a side effect.

Sends a real email (or reply) from a connected email account. Provide either threadId (reply; takes precedence if both are given) or connectedAccountId (new email). cc and bcc are plain email strings, unlike to which uses the { identifier } object form.

Starts a new chat thread (LinkedIn, WhatsApp, etc.) with one or more attendees from a connected account and sends the first message. This delivers a real message as a side effect.

Sent when a calendar on a connected account is created, updated, or deleted.

Sent when a calendar event on a connected account is created, updated, or deleted.

Sent when the provider reports a chat thread deletion.

Sent when a chat thread's provider attributes change (name, mute state, read state).

Sent when the provider reports an email deletion.

Sent when a new email is ingested on a connected email account.

Sent when the provider reports a message deletion.

Sent when a reaction is added to or removed from a message.

Sent when a new chat message or email is ingested on a connected account.

Sent when the provider reports an edit or status change for an ingested message.

Sent when the provider reports a new connection (e.g. an accepted LinkedIn invitation).