All requests require an API key for authentication.
\nInclude your key in the Authorization header using the Bearer token format:
Authorization: Bearer YOUR_API_KEY\n\nYou can generate and manage your API keys from your Dialllog account settings.
\nBefore running requests, set up the following environment variables in Postman:
\nAll responses are returned in JSON with standard HTTP status codes.
\nExample:
\n{\n \"status\": \"success\",\n \"payload\": {\n //\n }\n}\n\nRetrieves a company from the system.
\n","urlObject":{"path":["companies","{id}"],"host":["{{API_URL}}v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"edbbe81d-fbd7-4918-bb6d-1e8db6360ee5"},{"name":"Request All Companies","id":"f97c7ad1-c010-416a-857f-c4bfa7d3fbad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API_KEY}}"},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}v2/companies","description":"Retrieves a list of companies from the system.
This endpoint returns the key performance indicators (KPIs) for a specific company.
\nEach KPI represents a business metric (such as team size, customer growth, or cash burn) and includes values reported over one or more time periods, enabling tracking of performance and improvement over time.
\nEach KPI record includes the following fields:
\nStat name
The name of the KPI (e.g. Current team size, Customer Growth Rate (QoQ)).
Stat type
The data type of the KPI value. Possible values include:
number
percentage
currency
Periods
A list of time-based records for the KPI.
Each period object includes:
\nStart date
The beginning of the reporting period.
End date
The end of the reporting period.
Type
Indicates the nature of the data (e.g. actual).
Value
The KPI value for the period.
Improvement
The percentage change compared to the previous period, when applicable.
Empty if no comparison is available.
Returns a list of KPI objects.
\nEach KPI contains its associated time periods and values. The response is intended to support dashboards, analytics, and performance tracking views.
\n","urlObject":{"path":["companies","{id}","kpis"],"host":["{{API_URL}}v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"9a337015-a01f-4210-a2bc-50c3892bfbe9"},{"name":"Create a Company","id":"23f1d9c6-1a20-43af-93b4-eabe8908c00e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API_KEY}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"activity\": \"40b058e1-0ec5-1c41\",\n \"industry\": [\n \"1cdf4cd7-0b44-6cb0\"\n ],\n \"name\": \"Acme Co\",\n \"website\": \"https://acme.com\",\n \"phones\": [\n {\n \"name\": \"+38(099)111-11-11\",\n \"type\": \"2ea37af3-5dc3-d94d\"\n }\n ],\n \"note\": \"Long company note...\",\n \"customFieldValues\": [\n {\n \"id\": 23,\n \"value\": \"string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}v2/companies/","urlObject":{"path":["companies",""],"host":["{{API_URL}}v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"23f1d9c6-1a20-43af-93b4-eabe8908c00e"},{"name":"Get Company Creation Settings","id":"c1d771af-6a68-4dac-9d02-2b5155251af2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API_KEY}}"},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}v2/companies/add","description":"This endpoint returns all configuration data required to create a company in the system.
\nThe response provides predefined option lists and custom field definitions that can be used to dynamically build company creation forms and validate input on the client side.
\nThe response contains the following configuration groups:
\nA list of available industry options that a company can be associated with.
\nEach industry includes:
\nName – The display label of the industry
\nValue – The unique identifier for the industry
\nA list of possible company activity types.
\nEach activity includes:
\nName – The display label of the activity
\nValue – The unique identifier for the activity
\nA list of supported phone number types for company contact information.
\nEach phone type includes:
\nName – The display label of the phone type
\nValue – The unique identifier for the phone type
\nA list of configurable custom fields that may be attached to a company during creation.
\nEach custom field includes:
\nID – The unique identifier of the custom field
\nName – The display name of the field
\nType – The field input type (e.g. textarea, checkbox, date)
Values – A list of predefined values (empty for free-form fields)
\nRequired – Indicates whether the field is mandatory
\nSettings
\nRequired – Whether the field must be filled in
\nEnabled – Whether the field is active and should be displayed
\nReturns a settings object containing all available industries, activities, phone types, and custom field definitions.
\nThis endpoint is intended to be used when:
\nRendering company creation forms
\nValidating user input
\nDynamically supporting custom and configurable company fields
\nReturns a list of all available workflows.
\n","urlObject":{"path":["workflows",""],"host":["{{API_URL}}v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe1967c3-df8a-4286-a077-acac2c2ba80f"},{"name":"Get Available Workflow Stages","id":"f1def2ff-1582-4fa6-8ed4-003a9482cac6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{API_KEY}}"},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}v2/workflows/stages?workflow_id=5","description":"Retrieves the list of stages defined for a specific workflow.
\nEach stage represents a step in that workflow (for example, Screening, Due Diligence, Closed – Won).
\nStage identifiers are customizable short UUIDs, so clients should always use this endpoint to fetch valid stage IDs before using them as filters in the /companies endpoint.
Returns an array of stage objects.
\nEach object contains the following fields:
\nUse this endpoint to fetch valid stage IDs before filtering companies in a workflow.
\n Example filter: GET /companies?workflow_id={id}&stage={id}
Stage names are customizable and may change, so always rely on the id field for filtering.
Only workflows accessible to the authenticated user will return their stages.
\nRetrieves the list of interactions associated with a specific dialog.
\nEach interaction represents an activity or communication event related to a company’s dialog — for example, an email, meeting, call, or note.
\nThe dialog_id required for this request can be obtained from the /companies endpoint when it is queried with the workflow_id parameter. Each company listed in a workflow includes its corresponding dialog_id.
Returns an array of interaction objects.
\nEach object includes the following fields:
\nInteractions are tied to a specific dialog, not directly to a company.
\n To access them, first retrieve the company’s dialog_id from /companies?workflow_id={workflow_id}.
The endpoint returns only interactions visible to the authenticated user, based on their project and workflow permissions.
\nInteractions are ordered chronologically, with the most recent appearing first.
\nRetrieves detailed information about a single contact, including company details and contact information.
\nGET /contacts/{id}\n\nThis endpoint returns a single active contact by its unique identifier.
The response includes:
Contact personal and professional details
\nAssociated company information
\nEmail addresses
\nPhone numbers
\nGET /contacts/2633\n\n{\n \"success\": true,\n \"data\": {\n \"id\": 2633,\n \"name\": \"Aby\",\n \"company\": {\n \"id\": 3118,\n \"name\": \"AP Management\",\n \"website\": \"https://apmanagement.fr\",\n \"activity\": null,\n \"address\": \"\"\n },\n \"role\": \"\",\n \"department\": \"\",\n \"address\": \"\",\n \"city\": null,\n \"zip\": \"\",\n \"state\": \"\",\n \"country\": null,\n \"emails\": [],\n \"phone\": []\n }\n}\n\nEmpty strings (\"\") indicate optional fields with no data.
null values indicate unavailable or undefined data.
Empty emails or phone arrays mean no contact details are associated.
If the contact does not exist or is inactive, the API should return an appropriate error response.
\nRetrieves a paginated list of active contacts from the system.
The endpoint supports filtering by company, role, and search terms.
GET /contacts\n\nThis endpoint returns a list of active contacts available to the user.
Each contact may include associated company information, email addresses, and phone numbers.
Results are paginated, ordered by last name and then first name.
\nGET /contacts\n\nGET /contacts?page=2&per_page=25\n\nGET /contacts?company_id=10\n\nGET /contacts?role=manager\n\nGET /contacts?search=john\n\nThe endpoint returns a paginated list of contact objects.
\n{\n \"success\": true,\n \"data\": {\n \"data\": [\n {\n \"id\": 2633,\n \"name\": \"Aby\",\n \"company\": \"AP Management\",\n \"emails\": [],\n \"phone\": []\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 50,\n \"total\": 4667,\n \"last_page\": 94\n }\n }\n}\n\nOnly contacts with is_active = true are returned.
Results are ordered alphabetically by last name, then first name.
\nEmpty emails or phone arrays indicate no data is available for that contact.
Get various types and values for creating a contact and populating custom fields.
\n","urlObject":{"path":["contacts","add"],"host":["{{API_URL}}v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"66c26919-8d5d-4cca-ba81-483dae8b1b8c"}],"id":"4a98a356-51e5-4970-8c02-db8cf9ab14f0","_postman_id":"4a98a356-51e5-4970-8c02-db8cf9ab14f0","description":""}]}