Reuzenpanda Logo
API docs by Redocly

Reuzenpanda Public API Spec (v1)

Download OpenAPI specification:Download

Matthew Smeets: matthew@reuzenpanda.nl

This is the public API specification for the Reuzenpanda backend services.

Reuzenpanda Authorization Docs

Introduction

Authentication

You can read about how authentication works in our Authentication Documentation.

Glossary

  • Company Profile — An account of a whole company which contains several users.
  • Roles — Roles assigned to users within a company profile with different permissions (e.g., Admin, User).
  • Permission Tokens — JWT tokens that encapsulate the permissions of a user within a specific company profile.

Authentication

Endpoints for authentication

API User login

Authenticate an API user and initiate a login session.

Authorizations:
Authorization
Request Body schema: application/json
email
string
password
string

Responses

Response Schema: application/json
type
string
Enum: "SUCCESS" "BLOCKED" "LOCKED" "UNAUTHORIZED" "DO_NOT_ATTEMPT" "FORCE_REAUTHENTICATE" "ERROR"
object (authentication_UserDto)
sessionKey
string
attemptsLeft
integer <int32>
should_check_two_factor
boolean

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "user": {
    },
  • "sessionKey": "string",
  • "attemptsLeft": 0,
  • "should_check_two_factor": true
}

Get user profile

Retrieve the profile information of the currently authenticated user.

Authorizations:
Authorization

Responses

Response Schema: application/json
id
string <uuid>
email
string
name
string
image
string
locale
string
role
string
Enum: "ADMIN" "SUPPORT" "PARTNER" "BLOCKED" "API"
hub_mode
string
default_module
string
hide_user_image
boolean
isDealer
boolean

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "string",
  • "name": "string",
  • "image": "string",
  • "locale": "string",
  • "role": "ADMIN",
  • "hub_mode": "string",
  • "default_module": "string",
  • "hide_user_image": true,
  • "isDealer": true
}

Introduction

Company Profiles

A Company Profile is an account for a whole company which contains several users. Each user can have different roles and permissions within the Company Profile. Everything that is done is on behalf of the Company Profile, not on behalf of the individual user. So if a user makes changes, those changes are made to the Company Profile the user is logged in to at that moment.

Glossary

  • Company Profile — An account of a whole company which contains several users.
  • User — Member of a Company Profile.

Company Profile

Endpoints for managing company profiles

Get users for company profile by profile ID

Retrieve the list of users associated with a specific company profile using the profile ID.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

COMPANY PROFILE UUID

Responses

Response Schema: application/json
Array
id
string <uuid>
name
string
image
string
email
string

Response samples

Content type
application/json
[
  • {
    }
]

Get user for company profile by profile ID and user ID

Retrieve a specific user associated with a company profile using the profile ID and user ID.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

COMPANY PROFILE UUID

userId
required
string <uuid>

User UUID

Responses

Response Schema: application/json
id
string <uuid>
name
string
image
string
email
string

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "image": "string",
  • "email": "string"
}

List all company profiles

Retrieve a list of all company profiles.

Authorizations:
Authorization
query Parameters
onlyCurrentOwner
boolean

Responses

Response Schema: application/json
Array
id
string <uuid>
name
string
email
string
from_email
string
object (NotificationSettingsDto)
mollie_customer_id
string
object (ContactPersonDto)
object (AddressDto)
object (PhoneDto)
object (ChamberOfCommerceDto)
object (FinancialsDto)
object (QuotationSettingsDto)
object (MailchimpInfoDto)
object (EmailSettingsDto)
owner_user_id
string <uuid>
Array of objects (UserDto)
logo_url
string
terms_of_agreement_url
string
privacy_policy_url
string
object (SubscriptionDto)
object (InvoiceSettingsDto)
object (EmailSettingsDto)
object (InvoiceDetailsDto)
object (ContactInfoDto)
created_timestamp
integer <int64>
object (HubPreferencesDto)
object (ProfileDocumentSettingsDto)
object (GlobalLocationPrefsDto)
is_template_profile
boolean
object (DuplicationConsentDto)

Response samples

Content type
application/json
[
  • {
    }
]

Get all company profiles

Retrieve all company profiles accessible to the user.

Authorizations:
Authorization

Responses

Response Schema: application/json
Array
id
string <uuid>
name
string
email
string
from_email
string
object (NotificationSettingsDto)
mollie_customer_id
string
object (ContactPersonDto)
object (AddressDto)
object (PhoneDto)
object (ChamberOfCommerceDto)
object (FinancialsDto)
object (QuotationSettingsDto)
object (MailchimpInfoDto)
object (EmailSettingsDto)
owner_user_id
string <uuid>
Array of objects (UserDto)
logo_url
string
terms_of_agreement_url
string
privacy_policy_url
string
object (SubscriptionDto)
object (InvoiceSettingsDto)
object (EmailSettingsDto)
object (InvoiceDetailsDto)
object (ContactInfoDto)
created_timestamp
integer <int64>
object (HubPreferencesDto)
object (ProfileDocumentSettingsDto)
object (GlobalLocationPrefsDto)
is_template_profile
boolean
object (DuplicationConsentDto)

Response samples

Content type
application/json
[
  • {
    }
]

Get all company profiles

Retrieve all company profiles accessible to the user.

Authorizations:
Authorization

Responses

Response Schema: application/json
Array
id
string <uuid>
name
string
email
string
from_email
string
object (NotificationSettingsDto)
mollie_customer_id
string
object (ContactPersonDto)
object (AddressDto)
object (PhoneDto)
object (ChamberOfCommerceDto)
object (FinancialsDto)
object (QuotationSettingsDto)
object (MailchimpInfoDto)
object (EmailSettingsDto)
owner_user_id
string <uuid>
Array of objects (UserDto)
logo_url
string
terms_of_agreement_url
string
privacy_policy_url
string
object (SubscriptionDto)
object (InvoiceSettingsDto)
object (EmailSettingsDto)
object (InvoiceDetailsDto)
object (ContactInfoDto)
created_timestamp
integer <int64>
object (HubPreferencesDto)
object (ProfileDocumentSettingsDto)
object (GlobalLocationPrefsDto)
is_template_profile
boolean
object (DuplicationConsentDto)

Response samples

Content type
application/json
[
  • {
    }
]

Labels

Endpoints for managing labels

Get all labels

Retrieve all labels.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

COMPANY PROFILE UUID

Responses

Response Schema: application/json
message
string
Array of objects (LabelsDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "labels": [
    ]
}

Create label

Creates a new label with a random colour and UUID.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

COMPANY PROFILE UUID

Request Body schema: application/json
name
string

Responses

Response Schema: application/json
message
string
object (LabelsDto)

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "label": {
    }
}

Get label

Retrieve a specific label by its ID.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

COMPANY PROFILE UUID

labelId
required
string <uuid>

Label UUID

Responses

Response Schema: application/json
message
string
object (LabelsDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "label": {
    }
}

Delete label

Delete a label by its ID.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

COMPANY PROFILE UUID

labelId
required
string <uuid>

Label UUID

Responses

Response Schema: application/json
message
string
object (LabelsDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "label": {
    }
}

Update label

Update the name and/or colour of an existing label.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

COMPANY PROFILE UUID

labelId
required
string <uuid>

Label UUID

Request Body schema: application/json
name
string
colour
string

Responses

Response Schema: application/json
message
string
object (LabelsDto)

Request samples

Content type
application/json
{
  • "name": "string",
  • "colour": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "label": {
    }
}

Users

Endpoints for managing users in company profiles

Get users for company profile by profile ID

Retrieve the list of users associated with a specific company profile using the profile ID.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

COMPANY PROFILE UUID

Responses

Response Schema: application/json
Array
id
string <uuid>
name
string
image
string
email
string

Response samples

Content type
application/json
[
  • {
    }
]

Get user for company profile by profile ID and user ID

Retrieve a specific user associated with a company profile using the profile ID and user ID.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

COMPANY PROFILE UUID

userId
required
string <uuid>

User UUID

Responses

Response Schema: application/json
id
string <uuid>
name
string
image
string
email
string

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "image": "string",
  • "email": "string"
}

Introduction

CRM

The CRM system is used to track and manage leads and deals. You can manage these per board and per pipeline for a customized overview which is best for your use-case. Read more about the CRM system here.

Relations

The Relations Module is used to keep track of customers as a person or as a organisation. Read more about Relations here.

Glossary

  • Subject — (Mostly a request) is used to connect leads, deals, documents, notes, contactpersons & organisations with eachother.
  • Lead Configuration — Form submission of a lead.
  • Backlog — A pipeline in Reuzenpanda.
  • Backlog Column — A column of a pipeline.
  • Backlog Item — A Lead or Deal in a Pipeline.
  • Organisation — A company or business entity within relations.
  • Contact Person — An individual (mostly) associated with an organisation within relations.

CRM Activities

Endpoints for managing CRM activities

Get all activities for profile

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Responses

Response Schema: application/json
Array
id
string <uuid>
companyProfileId
string <uuid>
name
string
description
string
location
string
object (ExternalProperty)
object (ItemSubject)
eventTypeId
string <uuid>
status
string
Enum: "DONE" "NOT_DONE"
expired
boolean
object (ActivityScheduleDto)
rrule
string
recurrenceStart
integer <int64>
type
string
Enum: "EVENT" "BLOCK"
lastUpdated
integer <int64>

Response samples

Content type
application/json
[
  • {
    }
]

Create a new activity

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Request Body schema: application/json
companyProfileId
required
string <uuid>
name
required
string non-empty
description
string
location
string
object (ExternalProperty)
object (ItemSubject)
eventTypeId
string <uuid>
object (ActivityScheduleDto)
rrule
string
recurrenceStart
integer <int64>

Responses

Response Schema: application/json
id
string <uuid>
companyProfileId
string <uuid>
name
string
description
string
location
string
object (ExternalProperty)
object (ItemSubject)
eventTypeId
string <uuid>
status
string
Enum: "DONE" "NOT_DONE"
expired
boolean
object (ActivityScheduleDto)
rrule
string
recurrenceStart
integer <int64>
type
string
Enum: "EVENT" "BLOCK"
lastUpdated
integer <int64>

Request samples

Content type
application/json
{
  • "companyProfileId": "a62a281c-2674-468c-b1be-4af5777e3185",
  • "name": "string",
  • "description": "string",
  • "location": "string",
  • "assignee": {
    },
  • "itemSubject": {
    },
  • "eventTypeId": "f899218d-6f2c-4300-8a70-a6910536041b",
  • "schedule": {
    },
  • "rrule": "string",
  • "recurrenceStart": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "companyProfileId": "a62a281c-2674-468c-b1be-4af5777e3185",
  • "name": "string",
  • "description": "string",
  • "location": "string",
  • "assignee": {
    },
  • "itemSubject": {
    },
  • "eventTypeId": "f899218d-6f2c-4300-8a70-a6910536041b",
  • "status": "DONE",
  • "expired": true,
  • "schedule": {
    },
  • "rrule": "string",
  • "recurrenceStart": 0,
  • "type": "EVENT",
  • "lastUpdated": 0
}

Get activity by ID

Authorizations:
Authorization
path Parameters
activityId
required
string <uuid>

Responses

Response Schema: application/json
id
string <uuid>
companyProfileId
string <uuid>
name
string
description
string
location
string
object (ExternalProperty)
object (ItemSubject)
eventTypeId
string <uuid>
status
string
Enum: "DONE" "NOT_DONE"
expired
boolean
object (ActivityScheduleDto)
rrule
string
recurrenceStart
integer <int64>
type
string
Enum: "EVENT" "BLOCK"
lastUpdated
integer <int64>

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "companyProfileId": "a62a281c-2674-468c-b1be-4af5777e3185",
  • "name": "string",
  • "description": "string",
  • "location": "string",
  • "assignee": {
    },
  • "itemSubject": {
    },
  • "eventTypeId": "f899218d-6f2c-4300-8a70-a6910536041b",
  • "status": "DONE",
  • "expired": true,
  • "schedule": {
    },
  • "rrule": "string",
  • "recurrenceStart": 0,
  • "type": "EVENT",
  • "lastUpdated": 0
}

Delete activity

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

activityId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "INVALID_PERMISSION"
}

Update a activity

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

activityId
required
string <uuid>
Request Body schema: application/json
name
string
description
string
location
string
object (ExternalProperty)
object (ItemSubject)
eventTypeId
string <uuid>
object (ActivityScheduleDto)
status
string
Enum: "DONE" "NOT_DONE"
rrule
string
recurrenceStart
integer <int64>

Responses

Response Schema: application/json
id
string <uuid>
companyProfileId
string <uuid>
name
string
description
string
location
string
object (ExternalProperty)
object (ItemSubject)
eventTypeId
string <uuid>
status
string
Enum: "DONE" "NOT_DONE"
expired
boolean
object (ActivityScheduleDto)
rrule
string
recurrenceStart
integer <int64>
type
string
Enum: "EVENT" "BLOCK"
lastUpdated
integer <int64>

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "location": "string",
  • "assignee": {
    },
  • "itemSubject": {
    },
  • "eventTypeId": "f899218d-6f2c-4300-8a70-a6910536041b",
  • "schedule": {
    },
  • "status": "DONE",
  • "rrule": "string",
  • "recurrenceStart": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "companyProfileId": "a62a281c-2674-468c-b1be-4af5777e3185",
  • "name": "string",
  • "description": "string",
  • "location": "string",
  • "assignee": {
    },
  • "itemSubject": {
    },
  • "eventTypeId": "f899218d-6f2c-4300-8a70-a6910536041b",
  • "status": "DONE",
  • "expired": true,
  • "schedule": {
    },
  • "rrule": "string",
  • "recurrenceStart": 0,
  • "type": "EVENT",
  • "lastUpdated": 0
}

Clear lead configuration from activity

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

activityId
required
string <uuid>

Responses

Response Schema: application/json
id
string <uuid>
companyProfileId
string <uuid>
name
string
description
string
location
string
object (ExternalProperty)
object (ItemSubject)
eventTypeId
string <uuid>
status
string
Enum: "DONE" "NOT_DONE"
expired
boolean
object (ActivityScheduleDto)
rrule
string
recurrenceStart
integer <int64>
type
string
Enum: "EVENT" "BLOCK"
lastUpdated
integer <int64>

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "companyProfileId": "a62a281c-2674-468c-b1be-4af5777e3185",
  • "name": "string",
  • "description": "string",
  • "location": "string",
  • "assignee": {
    },
  • "itemSubject": {
    },
  • "eventTypeId": "f899218d-6f2c-4300-8a70-a6910536041b",
  • "status": "DONE",
  • "expired": true,
  • "schedule": {
    },
  • "rrule": "string",
  • "recurrenceStart": 0,
  • "type": "EVENT",
  • "lastUpdated": 0
}

EventTypes

Endpoints for managing eventTypes

Get all eventTypes for profile

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Responses

Response Schema: application/json
Array of objects (EventTypeDto)
message
string

Response samples

Content type
application/json
{
  • "eventTypes": [
    ],
  • "message": "string"
}

Create a new eventType

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Request Body schema: application/json
name
required
string non-empty
required
object (SlotDuration)
description
string
scheduleId
string <uuid>
minimumDuration
integer <int64>
object (Location)

Responses

Response Schema: application/json
object (EventTypeDto)
message
string

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
  • "slotDuration": {
    },
  • "minimumDuration": 0,
  • "location": {
    }
}

Response samples

Content type
application/json
{
  • "eventType": {
    },
  • "message": "string"
}

Book activity on slot

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Request Body schema: application/json
eventTypeId
required
string <uuid>
object (CreateCRMActivityRequest)
object (ContactInfo)

Responses

Response Schema: application/json
status
string
object (BookingSlotData)
object (CRMActivityDto)
message
string

Request samples

Content type
application/json
{
  • "eventTypeId": "f899218d-6f2c-4300-8a70-a6910536041b",
  • "activity": {
    },
  • "contactInfo": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "data": {
    },
  • "activity": {
    },
  • "message": "string"
}

Get eventType by ID

Authorizations:
Authorization
path Parameters
eventTypeId
required
string <uuid>

Responses

Response Schema: application/json
object (EventTypeDto)
message
string

Response samples

Content type
application/json
{
  • "eventType": {
    },
  • "message": "string"
}

Delete eventType

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

eventTypeId
required
string <uuid>

Responses

Response Schema: application/json
eventTypeId
string <uuid>
message
string

Response samples

Content type
application/json
{
  • "eventTypeId": "f899218d-6f2c-4300-8a70-a6910536041b",
  • "message": "string"
}

Update an eventType

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

eventTypeId
required
string <uuid>
Request Body schema: application/json
name
string
description
string
scheduleId
string <uuid>
object (SlotDuration)
minimumDuration
integer <int64>
object (Location)

Responses

Response Schema: application/json
object (EventTypeDto)
message
string

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
  • "slotDuration": {
    },
  • "minimumDuration": 0,
  • "location": {
    }
}

Response samples

Content type
application/json
{
  • "eventType": {
    },
  • "message": "string"
}

Get available booking slots

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

eventTypeId
required
string <uuid>
query Parameters
days
integer <int64>
Default: 5
timezone
string

Responses

Response Schema: application/json
object
message
string

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string"
}

Leads And Deals

Endpoints for managing Leads and Deals.

List Leads/Deals

Retrieves a list of Leads or Deals for a specified pipeline, with optional filtering, pagination, and configuration options.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

boardId
required
string <uuid>

Board UUID

backlogId
required
string <uuid>

Backlog UUID

query Parameters
filter
string <uuid>
page
integer <int32>
Default: -1
per_page
integer <int32>
Default: 0
hide_internal_configurations
boolean
Default: false
configurator_id
string <uuid>
date_preset
string
Enum: "custom" "last90days" "last30days" "last14days" "last7days" "thisweek" "today" "maximum"
date_from
integer <int64>
date_to
integer <int64>

Responses

Response Schema: application/json
message
string
Array of objects (ListBacklogItemDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "items": [
    ]
}

Copy Leads/Deals to Target Pipeline

Copies specified Leads or Deals to a target pipeline within the same or different leads/deals board.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

boardId
required
string <uuid>

Board UUID

backlogId
required
string <uuid>

Backlog UUID

Request Body schema: application/json
item_ids
Array of strings <uuid>
target_board_id
string <uuid>
target_backlog_id
string <uuid>
target_status_id
string <uuid>
old_item_label
string
Enum: "ITEM_ACTIVE" "ITEM_UNREAD" "DEAL_WON" "DEAL_LOST" "ITEM_CONVERTED" "ITEM_MOVED" "ITEM_ARCHIVED" "CONFIGURATION_CREATED"

Responses

Response Schema: application/json
message
string
Array of objects (ListBacklogItemDto)

Request samples

Content type
application/json
{
  • "item_ids": [
    ],
  • "target_board_id": "5eed75f5-aea8-4108-985e-f26b45a92320",
  • "target_backlog_id": "139439af-c033-40f4-819f-e531d938ad91",
  • "target_status_id": "c6b6a8c6-4df0-46c3-a71c-deb2b5e3f58d",
  • "old_item_label": "ITEM_ACTIVE"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "items": [
    ]
}

Update Lead/Deal

Updates an existing Lead or Deal with the provided details.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

boardId
required
string <uuid>

Board UUID

backlogId
required
string <uuid>

Backlog UUID

itemId
required
string <uuid>

Backlog Item UUID

Request Body schema: application/json
object (EntityBacklogItemDto)

Responses

Response Schema: application/json
message
string
object (EntityBacklogItemDto)

Request samples

Content type
application/json
{
  • "item": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "item": {
    }
}

Get Lead/Deal

Retrieve a specific Lead or Deal by its ID within a company profile's pipeline.

Authorizations:
Authorization
path Parameters
backlogId
required
string <uuid>

Backlog UUID

itemId
required
string <uuid>

Backlog Item UUID

Responses

Response Schema: application/json
message
string
object (BacklogItemMessage)

Response samples

Content type
application/json
{
  • "message": "string",
  • "item": {
    }
}

List Leads/Deals

Retrieve a list of leads or deals for a specific pipeline within a company profile. Optional filters can be applied.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

backlogId
required
string <uuid>

Backlog UUID

query Parameters
lead_configuration_id
string <uuid>
contact_person_id
string <uuid>
order_property
string
Default: "timestampUpdated"
order
string
Default: "desc"
excluded_labels
string

Responses

Response Schema: application/json
message
string
Array of objects (BacklogItemMessage)

Response samples

Content type
application/json
{
  • "message": "string",
  • "items": [
    ]
}

List Company Profile History

Retrieves the history of changes for a specific company profile.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Responses

Response Schema: application/json
Array of objects (ListCompanyProfileHistoryDto)

Response samples

Content type
application/json
{
  • "history": [
    ]
}

List Pipeline Statuses

Retrieves the list of pipeline statuses for a specific company profile.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Responses

Response Schema: application/json
Array of objects (BacklogStatusDto)

Response samples

Content type
application/json
{
  • "statuses": [
    ]
}

Leads/Deals Board

APIs for managing Leads/Deals Boards.

List Leads/Deals Boards

Retrieves a list of Leads/Deals Boards associated with the specified company profile.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

query Parameters
board_type
string
Enum: "LEADS" "DEALS" "ORDERS" "PAYMENTS" "PROJECTS"

Responses

Response Schema: application/json
message
string
Array of objects (EntityBoardDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "boards": [
    ]
}

Pipelines

APIs for managing pipelines

List Pipelines

Retrieves a list of Pipelines for a specific board within a company profile.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

boardId
required
string <uuid>

Board UUID

Responses

Response Schema: application/json
message
string
Array of objects (EntityBacklogDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "backlogs": [
    ]
}

Relations

API for managing relations.

List Contact Persons

Retrieve a list of contact persons associated with the specified profile ID.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Responses

Response Schema: application/json
message
string
Array of objects (ListContactPersonDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "contact_persons": [
    ]
}

Get Contact Person

Retrieve a specific contact person by their ID associated with the specified profile ID.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

contactPersonId
required
string <uuid>

Contact Person UUID

Responses

Response Schema: application/json
message
string
object (EntityContactPersonDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "contact_person": {
    }
}

Delete Contact Person

Delete a contact person associated with the specified profile ID.

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

contactPersonId
required
string <uuid>

Contact Person UUID

Responses

Response Schema: application/json
message
string
object (EntityContactPersonDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "contact_person": {
    }
}

RRule Exceptions

Endpoints for managing RRULE EXDATE exceptions

List RRULE exceptions for activity

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

activityId
required
string <uuid>

Responses

Response Schema: application/json
Array
id
string <uuid>
activityId
string <uuid>
excludedAt
integer <int64>

Response samples

Content type
application/json
[
  • {
    }
]

Create RRULE exception (EXDATE)

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

activityId
required
string <uuid>
Request Body schema: application/json
excludedAt
required
integer <int64>

Responses

Response Schema: application/json
id
string <uuid>
activityId
string <uuid>
excludedAt
integer <int64>

Request samples

Content type
application/json
{
  • "excludedAt": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "activityId": "bdfd0655-55e6-45e6-8bbc-6ed31d3820b5",
  • "excludedAt": 0
}

Delete RRULE exception

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

activityId
required
string <uuid>
exceptionId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "INVALID_PERMISSION"
}

Schedules

Endpoints for managing schedules

Get all schedules for profile

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Responses

Response Schema: application/json
Array of objects (ScheduleDto)
message
string

Response samples

Content type
application/json
{
  • "schedules": [
    ],
  • "message": "string"
}

Create a new schedule

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Request Body schema: application/json
required
object (Days)
name
required
string non-empty
timezone
required
string
syncCalendarId
string <uuid>

Responses

Response Schema: application/json
object (ScheduleDto)
message
string

Request samples

Content type
application/json
{
  • "name": "string",
  • "days": {
    },
  • "timezone": "string",
  • "syncCalendarId": "136d47c3-6438-4c6c-9c39-11a36070cd37"
}

Response samples

Content type
application/json
{
  • "schedule": {
    },
  • "message": "string"
}

Get schedule by ID

Authorizations:
Authorization
path Parameters
scheduleId
required
string <uuid>

Responses

Response Schema: application/json
object (ScheduleDto)
message
string

Response samples

Content type
application/json
{
  • "schedule": {
    },
  • "message": "string"
}

Delete schedule

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

scheduleId
required
string <uuid>

Responses

Response Schema: application/json
scheduleId
string <uuid>
message
string

Response samples

Content type
application/json
{
  • "scheduleId": "b7b4f318-018f-4d71-ac1a-f61e4bfaefbe",
  • "message": "string"
}

Update an schedule

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

scheduleId
required
string <uuid>
Request Body schema: application/json
name
string
object (Days)
timezone
string
syncCalendarId
string <uuid>

Responses

Response Schema: application/json
object (ScheduleDto)
message
string

Request samples

Content type
application/json
{
  • "name": "string",
  • "days": {
    },
  • "timezone": "string",
  • "syncCalendarId": "136d47c3-6438-4c6c-9c39-11a36070cd37"
}

Response samples

Content type
application/json
{
  • "schedule": {
    },
  • "message": "string"
}

Introduction

Document Service

Contracts

Document contract type

getContract

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Responses

Response Schema: application/json
message
string
object (ContractData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "contractData": {
    }
}

updateContract

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Request Body schema: application/json
documentId
string <uuid>
versionId
string <uuid>
profileId
string <uuid>
documentTitle
string
documentStatus
string
Enum: "DRAFT" "SENT" "ACCEPTED" "EXPIRED"
documentNumber
string
documentType
string
Enum: "QUOTATION" "INVOICE" "CONTRACT"
contractCreationTimestamp
integer <int64>
contractExpirationTimestamp
integer <int64>
isoCurrency
string
locale
string
archived
boolean
object
object
Array of objects (RenderRow)
renderTemplate
string
object

Responses

Response Schema: application/json
message
string
object (ContractData)

Request samples

Content type
application/json
{
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
  • "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "documentTitle": "string",
  • "documentStatus": "DRAFT",
  • "documentNumber": "string",
  • "documentType": "QUOTATION",
  • "contractCreationTimestamp": 0,
  • "contractExpirationTimestamp": 0,
  • "isoCurrency": "string",
  • "locale": "string",
  • "archived": true,
  • "subjects": {
    },
  • "segments": {
    },
  • "renderRows": [
    ],
  • "renderTemplate": "string",
  • "artifacts": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "contractData": {
    }
}

deleteContract

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

Responses

Response Schema: application/json
message
string
object (ContractData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "contractData": {
    }
}

signContract

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

query Parameters
name
required
string
artifactName
required
string
versionId
string <uuid>

Document version id (Each document has at least one version present)

Request Body schema: application/json
signatureFile
required
string <binary>

Responses

Response Schema: application/json
message
string
object (ContractData)

Request samples

Content type
application/json
{
  • "signatureFile": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "contractData": {
    }
}

cloneContract

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

query Parameters
title
string

Responses

Response Schema: application/json
message
string
object (ContractData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "contractData": {
    }
}

createContract

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Request Body schema: application/json
documentId
string <uuid>
versionId
string <uuid>
profileId
string <uuid>
documentTitle
string
documentStatus
string
Enum: "DRAFT" "SENT" "ACCEPTED" "EXPIRED"
documentNumber
string
documentType
string
Enum: "QUOTATION" "INVOICE" "CONTRACT"
contractCreationTimestamp
integer <int64>
contractExpirationTimestamp
integer <int64>
isoCurrency
string
locale
string
archived
boolean
object
object
Array of objects (RenderRow)
renderTemplate
string
object

Responses

Response Schema: application/json
message
string
object (ContractData)

Request samples

Content type
application/json
{
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
  • "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "documentTitle": "string",
  • "documentStatus": "DRAFT",
  • "documentNumber": "string",
  • "documentType": "QUOTATION",
  • "contractCreationTimestamp": 0,
  • "contractExpirationTimestamp": 0,
  • "isoCurrency": "string",
  • "locale": "string",
  • "archived": true,
  • "subjects": {
    },
  • "segments": {
    },
  • "renderRows": [
    ],
  • "renderTemplate": "string",
  • "artifacts": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "contractData": {
    }
}

getContracts

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

query Parameters
lead_configuration_id
string <uuid>

Responses

Response Schema: application/json
message
string
Array of objects (ContractListData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "contractListDatas": [
    ]
}

getContractPdf

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

artifactName
required
string
format
required
string
query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Responses

Response Schema: application/json
string <byte>

Response samples

Content type
application/json
"string"

getContractPreview

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

artifactName
required
string
query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Responses

Response Schema: application/json
string <byte>

Response samples

Content type
application/json
"string"

Document Templates

Document templates

listDocumentTemplates

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Responses

Response Schema: application/json
message
string
Array of objects (DocumentTemplateDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "documentTemplates": [
    ]
}

createDocumentTemplate

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Request Body schema: application/json
id
string <uuid>
documentType
string
Enum: "QUOTATION" "INVOICE" "CONTRACT" "WORK_ORDER" "UNSPECIFIED"
name
string
companyProfileId
string <uuid>
creationTimestamp
integer <int64>
lastModifiedTimestamp
integer <int64>
Array of objects (RenderRow)
renderTemplate
string
object
isoCurrency
string
locale
string
object

Responses

Response Schema: application/json
message
string
object (DocumentTemplateDto)

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "documentType": "QUOTATION",
  • "name": "string",
  • "companyProfileId": "a62a281c-2674-468c-b1be-4af5777e3185",
  • "creationTimestamp": 0,
  • "lastModifiedTimestamp": 0,
  • "renderRows": [
    ],
  • "renderTemplate": "string",
  • "segments": {
    },
  • "isoCurrency": "string",
  • "locale": "string",
  • "artifacts": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "documentTemplate": {
    }
}

getTemplate

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentTemplateId
required
string <uuid>

The id of a Document template

Responses

Response Schema: application/json
message
string
object (DocumentTemplateDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "documentTemplate": {
    }
}

deleteTemplate

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentTemplateId
required
string <uuid>

The id of a Document template

Responses

Response Schema: application/json
message
string
object (DocumentTemplateDto)

Response samples

Content type
application/json
{
  • "message": "string",
  • "documentTemplate": {
    }
}

updateTemplate

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentTemplateId
required
string <uuid>

The id of a Document template

Request Body schema: application/json
id
string <uuid>
documentType
string
Enum: "QUOTATION" "INVOICE" "CONTRACT" "WORK_ORDER" "UNSPECIFIED"
name
string
companyProfileId
string <uuid>
creationTimestamp
integer <int64>
lastModifiedTimestamp
integer <int64>
Array of objects (RenderRow)
renderTemplate
string
object
isoCurrency
string
locale
string
object

Responses

Response Schema: application/json
message
string
object (DocumentTemplateDto)

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "documentType": "QUOTATION",
  • "name": "string",
  • "companyProfileId": "a62a281c-2674-468c-b1be-4af5777e3185",
  • "creationTimestamp": 0,
  • "lastModifiedTimestamp": 0,
  • "renderRows": [
    ],
  • "renderTemplate": "string",
  • "segments": {
    },
  • "isoCurrency": "string",
  • "locale": "string",
  • "artifacts": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "documentTemplate": {
    }
}

getQuotationTemplate

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

query Parameters
templateName
string
Default: "defaultQuotation"

Responses

Response Schema: application/json
message
string
object (QuotationData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "quotationData": {
    }
}

getInvoiceTemplate

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

query Parameters
templateName
string
Default: "defaultInvoice"

Responses

Response Schema: application/json
message
string
object (InvoiceData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "invoiceData": {
    }
}

getContractTemplate

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

query Parameters
templateName
string
Default: "defaultContract"

Responses

Response Schema: application/json
message
string
object (ContractData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "contractData": {
    }
}

Documents

Generic Documents

getPdf

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

artifactName
required
string
format
required
string
query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Responses

Response Schema: application/json
string <byte>

Response samples

Content type
application/json
"string"

getDocuments

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Responses

Response Schema: application/json
message
string
Array of objects (DocumentListData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "documentDatas": [
    ]
}

Invoices

Document invoice type

getInvoice

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Responses

Response Schema: application/json
message
string
object (InvoiceData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "invoiceData": {
    }
}

updateInvoice

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Request Body schema: application/json
documentId
string <uuid>
versionId
string <uuid>
profileId
string <uuid>
documentTitle
string
documentStatus
string
Enum: "CREATED" "SENT" "PARTIALLY_PAID" "PAID" "EXPIRED"
documentNumber
string
documentType
string
Enum: "QUOTATION" "INVOICE" "CONTRACT"
title
string
Deprecated
invoiceNumber
string
Deprecated
invoiceTitle
string
Deprecated
invoiceCreationTimestamp
integer <int64>
invoiceDeliveryTimestamp
integer <int64>
invoiceExpirationTimestamp
integer <int64>
invoiceStatus
string
Deprecated
Enum: "CREATED" "SENT" "PARTIALLY_PAID" "PAID" "EXPIRED"
isoCurrency
string
locale
string
archived
boolean
object
object
object
Array of objects (RenderRow)
renderTemplate
string
object

Responses

Response Schema: application/json
message
string
object (InvoiceData)

Request samples

Content type
application/json
{
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
  • "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "documentTitle": "string",
  • "documentStatus": "CREATED",
  • "documentNumber": "string",
  • "documentType": "QUOTATION",
  • "title": "string",
  • "invoiceNumber": "string",
  • "invoiceTitle": "string",
  • "invoiceCreationTimestamp": 0,
  • "invoiceDeliveryTimestamp": 0,
  • "invoiceExpirationTimestamp": 0,
  • "invoiceStatus": "CREATED",
  • "isoCurrency": "string",
  • "locale": "string",
  • "archived": true,
  • "subjects": {
    },
  • "segments": {
    },
  • "pricing": {
    },
  • "renderRows": [
    ],
  • "renderTemplate": "string",
  • "artifacts": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "invoiceData": {
    }
}

deleteInvoice

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

Responses

Response Schema: application/json
message
string
object (InvoiceData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "invoiceData": {
    }
}

createInvoice

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Request Body schema: application/json
documentId
string <uuid>
versionId
string <uuid>
profileId
string <uuid>
documentTitle
string
documentStatus
string
Enum: "CREATED" "SENT" "PARTIALLY_PAID" "PAID" "EXPIRED"
documentNumber
string
documentType
string
Enum: "QUOTATION" "INVOICE" "CONTRACT"
title
string
Deprecated
invoiceNumber
string
Deprecated
invoiceTitle
string
Deprecated
invoiceCreationTimestamp
integer <int64>
invoiceDeliveryTimestamp
integer <int64>
invoiceExpirationTimestamp
integer <int64>
invoiceStatus
string
Deprecated
Enum: "CREATED" "SENT" "PARTIALLY_PAID" "PAID" "EXPIRED"
isoCurrency
string
locale
string
archived
boolean
object
object
object
Array of objects (RenderRow)
renderTemplate
string
object

Responses

Response Schema: application/json
message
string
object (InvoiceData)

Request samples

Content type
application/json
{
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
  • "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "documentTitle": "string",
  • "documentStatus": "CREATED",
  • "documentNumber": "string",
  • "documentType": "QUOTATION",
  • "title": "string",
  • "invoiceNumber": "string",
  • "invoiceTitle": "string",
  • "invoiceCreationTimestamp": 0,
  • "invoiceDeliveryTimestamp": 0,
  • "invoiceExpirationTimestamp": 0,
  • "invoiceStatus": "CREATED",
  • "isoCurrency": "string",
  • "locale": "string",
  • "archived": true,
  • "subjects": {
    },
  • "segments": {
    },
  • "pricing": {
    },
  • "renderRows": [
    ],
  • "renderTemplate": "string",
  • "artifacts": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "invoiceData": {
    }
}

getInvoices

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

query Parameters
lead_configuration_id
string <uuid>

Responses

Response Schema: application/json
message
string
Array of objects (InvoiceListData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "invoiceDatas": [
    ]
}

getInvoicePdf

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

artifactName
required
string
format
required
string
query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Responses

Response Schema: application/json
string <byte>

Response samples

Content type
application/json
"string"

getInvoicePreview

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

artifactName
required
string
query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Responses

Response Schema: application/json
string <byte>

Response samples

Content type
application/json
"string"

Message Composer

Message sending templates

updateComposeTemplate

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

composeTemplateId
required
string <uuid>

Composer message template id

Request Body schema: application/json
type
string
Enum: "EMAIL" "WHATSAPP"
object (TemplateContent)
name
string

Responses

Response Schema: application/json
message
string
object (ComposeTemplate)

Request samples

Content type
application/json
{
  • "type": "EMAIL",
  • "content": {
    },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "template": {
    }
}

deleteComposeTemplate

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

composeTemplateId
required
string <uuid>

Composer message template id

Responses

Response Schema: application/json
message
string
object (ComposeTemplate)

Response samples

Content type
application/json
{
  • "message": "string",
  • "template": {
    }
}

listComposeTemplates

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Responses

Response Schema: application/json
message
string
Array of objects (ComposeTemplate)

Response samples

Content type
application/json
{
  • "message": "string",
  • "templates": [
    ]
}

createComposeTemplate

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Request Body schema: application/json
type
string
Enum: "EMAIL" "WHATSAPP"
object (TemplateContent)
name
string

Responses

Response Schema: application/json
message
string
object (ComposeTemplate)

Request samples

Content type
application/json
{
  • "type": "EMAIL",
  • "content": {
    },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "template": {
    }
}

Quotations

Document quotation type

getQuotation

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Responses

Response Schema: application/json
message
string
object (QuotationData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "quotationData": {
    }
}

updateQuotation

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Request Body schema: application/json
documentId
string <uuid>
versionId
string <uuid>
profileId
string <uuid>
documentTitle
string
documentStatus
string
Enum: "DRAFT" "SENT" "ACCEPTED" "REJECTED"
documentNumber
string
documentType
string
Enum: "QUOTATION" "INVOICE" "CONTRACT"
title
string
Deprecated
quotationNumber
string
Deprecated
quotationTitle
string
Deprecated
quotationCreationTimestamp
integer <int64>
quotationExpirationTimestamp
integer <int64>
quotationStatus
string
Deprecated
Enum: "DRAFT" "SENT" "ACCEPTED" "REJECTED"
isoCurrency
string
locale
string
object
object
object
Array of objects (RenderRow)
renderTemplate
string
object

Responses

Response Schema: application/json
message
string
object (QuotationData)

Request samples

Content type
application/json
{
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
  • "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "documentTitle": "string",
  • "documentStatus": "DRAFT",
  • "documentNumber": "string",
  • "documentType": "QUOTATION",
  • "title": "string",
  • "quotationNumber": "string",
  • "quotationTitle": "string",
  • "quotationCreationTimestamp": 0,
  • "quotationExpirationTimestamp": 0,
  • "quotationStatus": "DRAFT",
  • "isoCurrency": "string",
  • "locale": "string",
  • "subjects": {
    },
  • "segments": {
    },
  • "pricing": {
    },
  • "renderRows": [
    ],
  • "renderTemplate": "string",
  • "artifacts": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "quotationData": {
    }
}

deleteQuotation

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

Responses

Response Schema: application/json
message
string
object (QuotationData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "quotationData": {
    }
}

signQuotation

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

query Parameters
name
required
string
artifactName
required
string
versionId
string <uuid>

Document version id (Each document has at least one version present)

Request Body schema: application/json
signatureFile
required
string <binary>

Responses

Response Schema: application/json
message
string
object (QuotationData)

Request samples

Content type
application/json
{
  • "signatureFile": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "quotationData": {
    }
}

convertQuotationToInvoice

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

query Parameters
templateName
required
string
templateId
string <uuid>

Responses

Response Schema: application/json
message
string
object (InvoiceData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "invoiceData": {
    }
}

cloneQuotation

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

query Parameters
title
string

Responses

Response Schema: application/json
message
string
object (QuotationData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "quotationData": {
    }
}

createQuotation

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

Request Body schema: application/json
documentId
string <uuid>
versionId
string <uuid>
profileId
string <uuid>
documentTitle
string
documentStatus
string
Enum: "DRAFT" "SENT" "ACCEPTED" "REJECTED"
documentNumber
string
documentType
string
Enum: "QUOTATION" "INVOICE" "CONTRACT"
title
string
Deprecated
quotationNumber
string
Deprecated
quotationTitle
string
Deprecated
quotationCreationTimestamp
integer <int64>
quotationExpirationTimestamp
integer <int64>
quotationStatus
string
Deprecated
Enum: "DRAFT" "SENT" "ACCEPTED" "REJECTED"
isoCurrency
string
locale
string
object
object
object
Array of objects (RenderRow)
renderTemplate
string
object

Responses

Response Schema: application/json
message
string
object (QuotationData)

Request samples

Content type
application/json
{
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
  • "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7",
  • "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",
  • "documentTitle": "string",
  • "documentStatus": "DRAFT",
  • "documentNumber": "string",
  • "documentType": "QUOTATION",
  • "title": "string",
  • "quotationNumber": "string",
  • "quotationTitle": "string",
  • "quotationCreationTimestamp": 0,
  • "quotationExpirationTimestamp": 0,
  • "quotationStatus": "DRAFT",
  • "isoCurrency": "string",
  • "locale": "string",
  • "subjects": {
    },
  • "segments": {
    },
  • "pricing": {
    },
  • "renderRows": [
    ],
  • "renderTemplate": "string",
  • "artifacts": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "quotationData": {
    }
}

getQuotations

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

query Parameters
lead_configuration_id
string <uuid>

Responses

Response Schema: application/json
message
string
Array of objects (QuotationListData)

Response samples

Content type
application/json
{
  • "message": "string",
  • "quotationDatas": [
    ]
}

getQuotationPdf

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

artifactName
required
string
format
required
string
query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Responses

Response Schema: application/json
string <byte>

Response samples

Content type
application/json
"string"

getQuotationSummary

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

artifactName
required
string
query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Responses

Response Schema: application/json
string <byte>

Response samples

Content type
application/json
"string"

getQuotationPreview

Authorizations:
Authorization
path Parameters
profileId
required
string <uuid>

Company Profile UUID

documentId
required
string <uuid>

The id of a document

artifactName
required
string
query Parameters
versionId
string <uuid>

Document version id (Each document has at least one version present)

Responses

Response Schema: application/json
string <byte>

Response samples

Content type
application/json
"string"

Introduction

Automations

Automations within Reuzenpanda are used to automate repetitive tasks and processes. They consist of triggers and actions that work together to perform specific functions based on predefined conditions. Read more about automations here.

Glossary

  • Automation — A combination of trigger and action that causes a specific task to be performed.
  • Plays — A Play is one execution of an automation.
  • Runs — A Run is one execution of a Play.
  • Trigger — The cause of an automation. It triggers the automation to start.
  • Action — The consequence of a trigger. It performs an action when the trigger occurs.

Webhooks

The webhooks in Reuzenpanda controls many triggers within the automation system. To integrate with webhooks, you can subscribe to webhooks within Reuzenpanda to use them as triggers for your own software. The important part is to know the Payload structure that is send with each webhook. To find the webhook events and their payloads, please refer to the Webhooks section in the OpenAPI documentation.

Webhook Subscriptions

Manage and subscribe to webhooks for various triggers

Subscribe Webhook

Subscribe a new webhook

Authorizations:
Authorization
Request Body schema: application/json
company_profile_id
required
string <uuid>
name
required
string
url
required
string
method
string
object
object
audience_id
string <uuid>
events
Array of strings
Items Enum: "QUOTATION_CREATED" "QUOTATION_CONTENTS_UPDATED" "QUOTATION_STATUS_UPDATED" "QUOTATION_DELETED" "INVOICE_CREATED" "INVOICE_CONTENTS_UPDATED" "INVOICE_STATUS_UPDATED" "INVOICE_DELETED" "CONTACT_CREATED" "CONTACT_UPDATED" "CONTACT_DELETED" "NOTE_CREATED" "NOTE_UPDATED" "NOTE_DELETED" "CONVERSATION_MESSAGE_SENT" "CONVERSATION_MESSAGE_NOT_SENT" "EMAIL_DELIVERED" "EMAIL_FAILED" "EMAIL_COMPLAINED" "LEAD_CONFIGURATION_PARTIAL" "LEAD_CONFIGURATION_FINALIZED" "LEAD_CONFIGURATION_SEEN" "LEAD_CONFIGURATION_ARCHIVED" "LEAD_CONFIGURATION_DELETED" "LEAD_CONFIGURATION_CONTACT_ASSIGNED" "LEAD_CONFIGURATION_QUOTATION_CREATED" "LEAD_CONFIGURATION_QUOTATION_CREATED_AUTOMATED" "REGISTRATION_LEAD_CREATED" "REGISTRATION_LEAD_FINALIZED" "CRM_BACKLOG_ITEM_CREATED" "CRM_BACKLOG_ITEM_RESULT_CHANGE" "CRM_BACKLOG_ITEM_STATUS_CHANGE" "CRM_BACKLOG_ITEM_ASSIGNEE_CHANGE" "CRM_BACKLOG_ITEM_COPIED" "CRM_BACKLOG_FREE_FIELD_CHANGE" "DOCUMENT_ATTACHED_TO_SENT_EMAIL" "DOCUMENT_QUOTATION_CREATED" "DOCUMENT_QUOTATION_UPDATED" "DOCUMENT_QUOTATION_SIGNED" "DOCUMENT_QUOTATION_DELETED" "DOCUMENT_INVOICE_CREATED" "DOCUMENT_INVOICE_UPDATED" "DOCUMENT_INVOICE_ARCHIVED" "DOCUMENT_CONTRACT_CREATED" "DOCUMENT_CONTRACT_UPDATED" "DOCUMENT_CONTRACT_SIGNED" "DOCUMENT_CONTRACT_DELETED" "DOCUMENT_STATUS_UPDATED" "AUTOMATION_INCOMING_WEBHOOK_RECEIVED" "ARTICLE_BULK_UPDATED" "PAYMENT_STATUS_UPDATED" "CONVERSATION_CHAT_CREATED" "ACTIVITY_CREATED" "ACTIVITY_STATUS_CHANGED" "COMPANY_PROFILE_CREATED" "COMPANY_PROFILE_UPDATED" "COMPANY_PROFILE_DELETED" "SUBSCRIPTION_CREATED" "SUBSCRIPTION_UPDATED"

Responses

Response Schema: application/json
object (TriggerSubscriber)
message
string
object

Request samples

Content type
application/json
Example

LEAD_CONFIGURATION_FINALIZED

{
  • "executorName": "webhook_executor",
  • "url": "https://example.com/webhook",
  • "events": [
    ],
  • "scope": { },
  • "headers": {
    }
}

Response samples

Content type
application/json
{
  • "subscription": {
    },
  • "message": "string",
  • "actions": {
    }
}

Receive Webhook

Receive a webhook to trigger an automation

Authorizations:
Authorization
path Parameters
automationId
required
string <uuid>

Automation UUID

Request Body schema: application/json
string

Responses

Response Schema: application/json
string

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

List Subscriptions in Company Profile

List all subscriptions for a specific company profile

Authorizations:
Authorization
query Parameters
profile_id
string

Responses

Response Schema: application/json
Array
executor
required
string
Value: "webhook"
name
required
string
required
object (ScopeParameters)

Extra parameters beside the ones shown are allowed, please consult the documentation for more details

id
string <uuid>
userId
string <uuid>
accessTokenId
string <uuid>
events
Array of strings
Items Enum: "QUOTATION_CREATED" "QUOTATION_CONTENTS_UPDATED" "QUOTATION_STATUS_UPDATED" "QUOTATION_DELETED" "INVOICE_CREATED" "INVOICE_CONTENTS_UPDATED" "INVOICE_STATUS_UPDATED" "INVOICE_DELETED" "CONTACT_CREATED" "CONTACT_UPDATED" "CONTACT_DELETED" "NOTE_CREATED" "NOTE_UPDATED" "NOTE_DELETED" "CONVERSATION_MESSAGE_SENT" "CONVERSATION_MESSAGE_NOT_SENT" "EMAIL_DELIVERED" "EMAIL_FAILED" "EMAIL_COMPLAINED" "LEAD_CONFIGURATION_PARTIAL" "LEAD_CONFIGURATION_FINALIZED" "LEAD_CONFIGURATION_SEEN" "LEAD_CONFIGURATION_ARCHIVED" "LEAD_CONFIGURATION_DELETED" "LEAD_CONFIGURATION_CONTACT_ASSIGNED" "LEAD_CONFIGURATION_QUOTATION_CREATED" "LEAD_CONFIGURATION_QUOTATION_CREATED_AUTOMATED" "REGISTRATION_LEAD_CREATED" "REGISTRATION_LEAD_FINALIZED" "CRM_BACKLOG_ITEM_CREATED" "CRM_BACKLOG_ITEM_RESULT_CHANGE" "CRM_BACKLOG_ITEM_STATUS_CHANGE" "CRM_BACKLOG_ITEM_ASSIGNEE_CHANGE" "CRM_BACKLOG_ITEM_COPIED" "CRM_BACKLOG_FREE_FIELD_CHANGE" "DOCUMENT_ATTACHED_TO_SENT_EMAIL" "DOCUMENT_QUOTATION_CREATED" "DOCUMENT_QUOTATION_UPDATED" "DOCUMENT_QUOTATION_SIGNED" "DOCUMENT_QUOTATION_DELETED" "DOCUMENT_INVOICE_CREATED" "DOCUMENT_INVOICE_UPDATED" "DOCUMENT_INVOICE_ARCHIVED" "DOCUMENT_CONTRACT_CREATED" "DOCUMENT_CONTRACT_UPDATED" "DOCUMENT_CONTRACT_SIGNED" "DOCUMENT_CONTRACT_DELETED" "DOCUMENT_STATUS_UPDATED" "AUTOMATION_INCOMING_WEBHOOK_RECEIVED" "ARTICLE_BULK_UPDATED" "PAYMENT_STATUS_UPDATED" "CONVERSATION_CHAT_CREATED" "ACTIVITY_CREATED" "ACTIVITY_STATUS_CHANGED" "COMPANY_PROFILE_CREATED" "COMPANY_PROFILE_UPDATED" "COMPANY_PROFILE_DELETED" "SUBSCRIPTION_CREATED" "SUBSCRIPTION_UPDATED"
createdAt
integer <int64>
object (WebhookExecutorParameters)

Response samples

Content type
application/json
[
  • {
    }
]

Unsubscribe

Remove a subscription

Authorizations:
Authorization
query Parameters
id
required
string <uuid>

Responses

Response Schema: application/json
boolean

Response samples

Content type
application/json
true

Webhooks

Events related to webhooks

Lead Configuration Finalized

LEAD_CONFIGURATION_FINALIZED

Triggered when a lead/deal is created or a form is submitted.

The key difference compared to CRM_BACKLOG_ITEM_CREATED is the data included in the payload:

  • LEAD_CONFIGURATION_FINALIZED contains the form unput fields that were submitted.
  • CRM_BACKLOG_ITEM_CREATED only includes the contact details.

Note: input_fields is dynamic and can differ per form/configuration. We recommend inspecting the structure per payload and using the fields in the way that best fits your use case.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json

LEAD_CONFIGURATION_FINALIZED

{
  • "id": 25064710,
  • "timestamp": 1766062609,
  • "eventName": "LEAD_CONFIGURATION_FINALIZED",
  • "payload": {
    },
  • "metadata": {
    }
}

Status Updated

DOCUMENT_STATUS_UPDATED

Triggered when the status of a document is updated.

You can use the fields in this payload to understand what changed and to filter events in your webhook subscription:

  • old_document_status: the document status before the change. You can use this value to scope events for specific transitions
  • document_status: the new document status after the change.
  • document_type: the type of document (e.g., INVOICE, QUOTATION, CONTRACT)
  • document_id: used to identify which document was updated

You can scope on the following statuses: SENT, EXPIRED, ACCEPTED, REJECTED, PAID, PARTIALLY_PAID.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json

DOCUMENT_STATUS_UPDATED

{
  • "id": -1629111826,
  • "timestamp": 1766148551,
  • "eventName": "DOCUMENT_STATUS_UPDATED",
  • "payload": {
    },
  • "metadata": {
    }
}

Quotation Created

DOCUMENT_QUOTATION_CREATED

Triggered when a new quotation is created.

The same payload structure as DOCUMENT_INVOICE_CREATED is used for quotations. Note: segments and renderRows are dynamic and can differ per document.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json

DOCUMENT_QUOTATION_CREATED

{
  • "id": 934926516,
  • "timestamp": 1766147986,
  • "eventName": "DOCUMENT_QUOTATION_CREATED",
  • "payload": {
    },
  • "metadata": {
    }
}

Invoice Created

DOCUMENT_INVOICE_CREATED

Triggered when a new invoice is created.

Note that segments and renderRows represent the document's dynamic layout. Because this structure can vary per document, it's not practical to define it as a fixed, static schema. We recommend inspecting these fields on a per-document basis and using them in the way that best fits your use case.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json

DOCUMENT_INVOICE_CREATED

{
  • "id": -1632424344,
  • "timestamp": 1766146714,
  • "eventName": "DOCUMENT_INVOICE_CREATED",
  • "payload": {
    },
  • "metadata": {
    }
}

Contract Created

DOCUMENT_CONTRACT_CREATED

Triggered when a new contract is created.

Note: segments and renderRows are dynamic and can differ per document. The content of the contract will be shown within segments.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json

DOCUMENT_CONTRACT_CREATED

{
  • "id": -1699372250,
  • "timestamp": 1766147292,
  • "eventName": "DOCUMENT_CONTRACT_CREATED",
  • "payload": {
    },
  • "metadata": {
    }
}

Deal Status Changed

CRM_BACKLOG_ITEM_STATUS_CHANGE

Triggered when the status of a deal has changed in the CRM system. Every column in a pipeline is considered a status.

The metadata fields old_status_id and status_id indicate the previous and new status of the deal which you can scope on in your webhook subscription.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json

CRM_BACKLOG_ITEM_STATUS_CHANGE

{
  • "id": 123456789,
  • "timestamp": 1234567890,
  • "eventName": "CRM_BACKLOG_ITEM_STATUS_CHANGE",
  • "payload": {
    },
  • "metadata": {
    }
}

Deal Won/Lost

CRM_BACKLOG_ITEM_RESULT_CHANGE

Triggered when a deal is marked as lost or won in the CRM system.

The metadata field result indicates whether the deal was marked as "lost" or "won".

Authorizations:
Authorization

Responses

Response samples

Content type
application/json

CRM_BACKLOG_ITEM_RESULT_CHANGE

{
  • "id": 123456789,
  • "timestamp": 1234567890,
  • "eventName": "CRM_BACKLOG_ITEM_RESULT_CHANGE",
  • "payload": {
    },
  • "metadata": {
    }
}

Lead/Deal Created

CRM_BACKLOG_ITEM_CREATED

Triggered when a new lead or deal is created in the CRM system.

Here are some important things to keep in mind when working with this webhook event:

  • To retrieve the contact details for a lead/deal, use the id from item_subject and query the Relations endpoints. The webhook does not guarantee that fields, summary or description are always present or up to date. For example, if a contact is updated, those values in the webhook payload may not reflect the latest changes.
  • internal_configuration indicates whether the lead/deal was created manually or via an automation. You can use this field to filter webhook deliveries by setting an appropriate scope in your subscription.
  • item_type tells you whether the item is a Lead or a Deal
  • backlog_id is the pipeline ID where the lead/deal currently resides.
  • board_id is the board ID where the lead/deal is located.

You can scope your webhook subscription using these fields to ensure you only receive the data you need.

If item_type is Lead, you don't need to scope on board_id, because it is always the same for leads.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json

CRM_BACKLOG_ITEM_CREATED

{
  • "id": 123456789,
  • "timestamp": 1234567890,
  • "eventName": "CRM_BACKLOG_ITEM_CREATED",
  • "payload": {
    },
  • "metadata": {
    }
}

Lead Converted To Deal

CRM_BACKLOG_ITEM_COPIED

Triggered when a lead is converted to a deal in the CRM system.

The metadata fields source_board_id and source_backlog_id indicate the original board and pipeline from which the lead was converted and the metadata fields board_id and backlog_id indicate the new board and pipeline where the deal now resides.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json

CRM_BACKLOG_ITEM_COPIED

{
  • "id": 123456789,
  • "timestamp": 1234567890,
  • "eventName": "CRM_BACKLOG_ITEM_COPIED",
  • "payload": {
    },
  • "metadata": {
    }
}

Lead/Deal Assignee Changed

CRM_BACKLOG_ITEM_ASSIGNEE_CHANGE

Triggered when an assignee is added or changed for a lead/deal in the CRM system.

The metadata fields old_assignee_id and assignee_id indicate the previous and new assignee of the lead/deal which you can scope on in your webhook subscription.

Authorizations:
Authorization

Responses

Response samples

Content type
application/json

CRM_BACKLOG_ITEM_ASSIGNEE_CHANGE

{
  • "id": 123456789,
  • "timestamp": 1234567890,
  • "eventName": "CRM_BACKLOG_ITEM_ASSIGNEE_CHANGE",
  • "payload": {
    },
  • "metadata": {
    }
}