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 IDs 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 requires an ID. 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 sorting and pagination.