Leads

GET

Retrieves all leads for the authenticated user's team.

GET/leads

Response

200403

Leads retrieved successfully

Body

application/json

countnumber

Example: 10

leadsarray of object

Request

JavaScriptCurlPython

const response = await fetch('/leads', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403

{
  "count": 10,
  "leads": [
    {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "email": "[e-mail]",
      "phoneNumber": [
        "123-456-7890"
      ],
      "status": "New",
      "business": [
        {
          "id": 1,
          "name": "Business Name"
        }
      ]
    }
  ]
}

Searches for leads based on the provided search term.

GET/leads/search

Response

200403

Leads retrieved successfully

Body

application/json

idnumber

Example: 1

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

emailstring

Example: "[e-mail]"

phoneNumberarray of string

statusstring

Example: "New"

businessarray of object

Request

JavaScriptCurlPython

const response = await fetch('/leads/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403

[
  {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]",
    "phoneNumber": [
      "123-456-7890"
    ],
    "status": "New",
    "business": [
      {
        "id": 1,
        "name": "Business Name"
      }
    ]
  }
]

Retrieves a lead by its ID.

GET/leads/{id}

Path parameters

id*string

Response

200403404

Lead retrieved successfully

Body

application/json

idnumber

Example: 1

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

emailstring

Example: "[e-mail]"

phoneNumberarray of string

statusstring

Example: "New"

businessarray of object

Request

JavaScriptCurlPython

const response = await fetch('/leads/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "id": 1,
  "firstName": "John",
  "lastName": "Doe",
  "email": "[e-mail]",
  "phoneNumber": [
    "123-456-7890"
  ],
  "status": "New",
  "business": [
    {
      "id": 1,
      "name": "Business Name"
    }
  ]
}

Retrieves lead statuses for the authenticated user's team.

GET/leads/statuses

Response

200403

Lead statuses retrieved successfully

Body

application/json

statusesarray of object

colorsarray of string

Request

JavaScriptCurlPython

const response = await fetch('/leads/statuses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403

{
  "statuses": [
    {
      "id": 1,
      "name": "New",
      "primaryColor": "blue",
      "secondaryColor": "lightblue"
    }
  ],
  "colors": [
    "blue"
  ]
}

Retrieves the volume of leads per business per day.

GET/leads/leads-volume

Response

200403

Leads volume retrieved successfully

Body

application/json

labelsarray of string

dataobject

totalLeadsAmountnumber

Example: 100

percentageChangenumber

Example: 10

Request

JavaScriptCurlPython

const response = await fetch('/leads/leads-volume', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403

{
  "labels": [
    "2023-01-01",
    "2023-01-02"
  ],
  "totalLeadsAmount": 100,
  "percentageChange": 10
}

Counts the total number of leads over a specified period.

GET/leads/total-leads

Response

200403

Total leads counted successfully

Body

application/json

namestring

Example: "New"

currentnumber

Example: 10

percentageChangenumber

Example: 10

colorstring

Example: "blue"

backgroundColorstring

Example: "lightblue"

Request

JavaScriptCurlPython

const response = await fetch('/leads/total-leads', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403

{
  "name": "New",
  "current": 10,
  "percentageChange": 10,
  "color": "blue",
  "backgroundColor": "lightblue"
}

Finds the five most recent leads over a specified period.

GET/leads/recent-leads

Response

200403

Recent leads found successfully

Body

application/json

idnumber

Example: 1

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

emailstring

Example: "[e-mail]"

phoneNumberarray of string

statusstring

Example: "New"

businessarray of object

Request

JavaScriptCurlPython

const response = await fetch('/leads/recent-leads', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403

[
  {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]",
    "phoneNumber": [
      "123-456-7890"
    ],
    "status": "New",
    "business": [
      {
        "id": 1,
        "name": "Business Name"
      }
    ]
  }
]

Retrieves the number of leads per business over a specified period.

GET/leads/leads-per-business

Response

200403

Leads per business retrieved successfully

Body

application/json

Other propertiesnumber

Example: 10

Request

JavaScriptCurlPython

const response = await fetch('/leads/leads-per-business', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

403

{
  "message": "Access denied",
  "description": "<p>You do not have permission to access this data.</p>",
  "__$markdownParsed": true
}

Retrieves a photo for a lead by its file name.

GET/leads/get-photo/{fileName}

Path parameters

fileName*string

Response

200404

Photo retrieved successfully

Body

application/json

string (binary)

Request

JavaScriptCurlPython

const response = await fetch('/leads/get-photo/{fileName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

binary

Retrieves logs for a lead by its ID.

GET/leads/logs/{id}

Path parameters

id*number

Response

200400403404

Logs retrieved successfully

Body

application/json

countnumber

Example: 5

logsarray of object

Request

JavaScriptCurlPython

const response = await fetch('/leads/logs/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "count": 5,
  "logs": [
    {
      "id": 1,
      "action": "CreateLead",
      "entityType": "Lead",
      "user": {
        "id": 1,
        "email": "[e-mail]"
      },
      "createdAt": "2023-01-01T00:00:00Z"
    }
  ]
}

Retrieves logs and comments for a lead by its ID.

GET/leads/logs-and-comments/{id}

Path parameters

id*number

Response

200400403404

Logs and comments retrieved successfully

Body

application/json

logsAndCommentsarray of object

logsCountnumber

Example: 5

commentsCountnumber

Example: 5

Request

JavaScriptCurlPython

const response = await fetch('/leads/logs-and-comments/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "logsAndComments": [
    {
      "id": 1,
      "action": "CreateLead",
      "entityType": "Lead",
      "user": {
        "id": 1,
        "email": "[e-mail]"
      },
      "content": "This is a comment.",
      "createdAt": "2023-01-01T00:00:00Z"
    }
  ],
  "logsCount": 5,
  "commentsCount": 5
}

POST

Creates a new lead.

POST/leads

Body

application/json

Lead creation data

firstName*string

First name of the lead

Example: "John"

lastName*string

Last name of the lead

Example: "Doe"

business*nullable array of number

Business IDs associated with the lead

photo*nullable string

Photo of the lead

Example: "photo.jpg"

state*enum

State of the lead

Example: "Active"

ActiveDone

statusId*number

Status ID of the lead

Example: 1

source*string

Source of the lead

Example: "Referral"

phoneNumber*array of string

Phone numbers of the lead

email*string

Email of the lead

Example: "[e-mail]"

description*nullable string

Description of the lead

Example: "Lead description"

location*string

Location of the lead

Example: "New York"

socialMedia*object

Social media links of the lead

position*nullable string

Position of the lead

Example: "Manager"

company*nullable string

Company of the lead

Example: "Company Name"

Response

201400404500

Lead created successfully

Body

application/json

idnumber

Example: 1

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

emailstring

Example: "[e-mail]"

phoneNumberarray of string

statusstring

Example: "New"

businessarray of object

Request

JavaScriptCurlPython

const response = await fetch('/leads', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": "John",
      "lastName": "Doe",
      "business": [
        1,
        2,
        3
      ],
      "photo": "photo.jpg",
      "state": "Active",
      "statusId": 1,
      "source": "Referral",
      "phoneNumber": [
        "123-456-7890"
      ],
      "email": "[e-mail]",
      "description": "Lead description",
      "location": "New York",
      "socialMedia": {},
      "position": "Manager",
      "company": "Company Name"
    }),
});
const data = await response.json();

Response

201400404500

{
  "id": 1,
  "firstName": "John",
  "lastName": "Doe",
  "email": "[e-mail]",
  "phoneNumber": [
    "123-456-7890"
  ],
  "status": "New",
  "business": [
    {
      "id": 1,
      "name": "Business Name"
    }
  ]
}

Creates a new lead status for the authenticated user's team.

POST/leads/status

Body

application/json

Lead status creation data

name*string

Name of the lead status

Example: "New"

primaryColor*enum

Primary color of the lead status

Example: "#6610F2"

#596579#E83E8C#038FDD#17A2B8#6610F2#EBB000#28A745#94CA0C#FD7E14#6F42C1#DC3545#FA541C

Response

201400500

Lead status created successfully

Body

application/json

idnumber

Example: 1

namestring

Example: "New"

primaryColorstring

Example: "blue"

secondaryColorstring

Example: "lightblue"

Request

JavaScriptCurlPython

const response = await fetch('/leads/status', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "New",
      "primaryColor": "#6610F2"
    }),
});
const data = await response.json();

Response

201400500

{
  "id": 1,
  "name": "New",
  "primaryColor": "blue",
  "secondaryColor": "lightblue"
}

Uploads a photo for a lead.

POST/leads/upload-photo

Body

application/json

Photo upload data

idnumber

Example: 1

photostring (binary)

Response

200400403

Photo uploaded successfully

Body

application/json

string

Example: "formatted_file_name.jpg"

Request

JavaScriptCurlPython

const response = await fetch('/leads/upload-photo', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403

formatted_file_name.jpg

Leaves a comment on a lead.

POST/leads/comments/{id}

Path parameters

id*number

Body

application/json

Comment data

contentstring

Example: "This is a comment."

Response

201400403404

Comment added successfully

Body

application/json

idnumber

Example: 1

contentstring

Example: "This is a comment."

userobject

createdAtstring (date-time)

Example: "2023-01-01T00:00:00Z"

Request

JavaScriptCurlPython

const response = await fetch('/leads/comments/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400403404

{
  "id": 1,
  "content": "This is a comment.",
  "user": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]"
  },
  "createdAt": "2023-01-01T00:00:00Z"
}

PATCH

Archives multiple leads.

PATCH/leads/archive

Body

application/json

Lead archiving data

idsarray of number

Response

200400403500

Leads archived successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/leads/archive', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403500

{
  "message": "Leads archived successfully",
  "description": "<p>The leads have been archived successfully.</p>",
  "__$markdownParsed": true
}

Restores multiple archived leads.

PATCH/leads/restore

Body

application/json

Lead restoration data

idsarray of number

Response

200400403500

Leads restored successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/leads/restore', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403500

{
  "message": "Leads restored successfully",
  "description": "<p>The leads have been restored successfully.</p>",
  "__$markdownParsed": true
}

PUT

Updates a lead by its ID.

PUT/leads/{id}

Path parameters

id*string

Body

application/json

Lead update data

firstName*nullable string

First name of the lead

Example: "John"

lastName*nullable string

Last name of the lead

Example: "Doe"

business*nullable array of number

Business IDs associated with the lead

photo*nullable string

Photo of the lead

Example: "photo.jpg"

state*nullable enum

State of the lead

Example: "Active"

ActiveDone

statusId*nullable number

Status ID of the lead

Example: 1

source*nullable string

Source of the lead

Example: "Referral"

phoneNumber*nullable array of string

Phone numbers of the lead

description*nullable string

Description of the lead

Example: "Lead description"

location*nullable string

Location of the lead

Example: "New York"

socialMedia*nullable object

Social media links of the lead

position*nullable string

Position of the lead

Example: "Manager"

company*nullable string

Company of the lead

Example: "Company Name"

Response

200400403404

Lead updated successfully

Body

application/json

idnumber

Example: 1

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

emailstring

Example: "[e-mail]"

phoneNumberarray of string

statusstring

Example: "Updated Status"

businessarray of object

Request

JavaScriptCurlPython

const response = await fetch('/leads/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": "John",
      "lastName": "Doe",
      "business": [
        1,
        2,
        3
      ],
      "photo": "photo.jpg",
      "state": "Active",
      "statusId": 1,
      "source": "Referral",
      "phoneNumber": [
        "123-456-7890"
      ],
      "description": "Lead description",
      "location": "New York",
      "socialMedia": {},
      "position": "Manager",
      "company": "Company Name"
    }),
});
const data = await response.json();

Response

200400403404

{
  "id": 1,
  "firstName": "John",
  "lastName": "Doe",
  "email": "[e-mail]",
  "phoneNumber": [
    "123-456-7890"
  ],
  "status": "Updated Status",
  "business": [
    {
      "id": 1,
      "name": "Business Name"
    }
  ]
}

Changes the status of multiple leads.

PUT/leads/change-status

Body

application/json

Lead status change data

ids*array of number

Array of lead IDs

statusId*number

Status ID to be applied to the leads

Example: 1

Response

200400403404

Lead statuses updated successfully

Body

application/json

idnumber

Example: 1

statusstring

Example: "Updated Status"

Request

JavaScriptCurlPython

const response = await fetch('/leads/change-status', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ids": [
        1,
        2,
        3
      ],
      "statusId": 1
    }),
});
const data = await response.json();

Response

200400403404

[
  {
    "id": 1,
    "status": "Updated Status"
  }
]

Updates a lead status by its ID.

PUT/leads/status/{id}

Path parameters

id*string

Body

application/json

Lead status update data

name*nullable string

Name of the lead status

Example: "New"

primaryColor*nullable enum

Primary color of the lead status

Example: "blue"

#596579#E83E8C#038FDD#17A2B8#6610F2#EBB000#28A745#94CA0C#FD7E14#6F42C1#DC3545#FA541C

Response

200400500

Lead status updated successfully

Body

application/json

idnumber

Example: 1

namestring

Example: "Updated Status"

primaryColorstring

Example: "green"

secondaryColorstring

Example: "lightgreen"

Request

JavaScriptCurlPython

const response = await fetch('/leads/status/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "New",
      "primaryColor": "blue"
    }),
});
const data = await response.json();

Response

200400500

{
  "id": 1,
  "name": "Updated Status",
  "primaryColor": "green",
  "secondaryColor": "lightgreen"
}

Updates the order of lead statuses.

PUT/leads/statuses/order

Body

application/json

Lead statuses order update data

id*number

ID of the status

Example: 1

statusOrder*number

Order of the status

Example: 1

Response

200500

Lead statuses order updated successfully

Body

application/json

idnumber

Example: 1

statusOrdernumber

Example: 1

Request

JavaScriptCurlPython

const response = await fetch('/leads/statuses/order', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": 1,
      "statusOrder": 1
    }),
});
const data = await response.json();

Response

200500

[
  {
    "id": 1,
    "statusOrder": 1
  }
]

Edits a comment on a lead.

PUT/leads/comments/{id}

Path parameters

id*number

Body

application/json

Comment edit data

contentstring

Example: "This is an edited comment."

Response

200400403404

Comment edited successfully

Body

application/json

idnumber

Example: 1

contentstring

Example: "This is an edited comment."

userobject

createdAtstring (date-time)

Example: "2023-01-01T00:00:00Z"

Request

JavaScriptCurlPython

const response = await fetch('/leads/comments/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403404

{
  "id": 1,
  "content": "This is an edited comment.",
  "user": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "email": "[e-mail]"
  },
  "createdAt": "2023-01-01T00:00:00Z"
}

DELETE

Deletes multiple leads.

DELETE/leads

Body

application/json

Lead deletion data

idsarray of number

Response

200400403500

Leads deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/leads', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400403500

{
  "message": "Leads deleted successfully",
  "description": "<p>The leads have been deleted successfully.</p>",
  "__$markdownParsed": true
}

Deletes a photo for a lead by its file name.

DELETE/leads/delete-photo/{fileName}

Path parameters

fileName*string

Response

200404

Photo deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/leads/delete-photo/{fileName}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "message": "Photo deleted successfully",
  "description": "<p>The photo has been deleted successfully.</p>",
  "__$markdownParsed": true
}

Deletes a lead status by its ID.

DELETE/leads/status/{id}

Path parameters

id*string

Response

200400500

Lead status deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/leads/status/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "message": "Lead status deleted successfully",
  "description": "<p>The lead status has been deleted successfully.</p>",
  "__$markdownParsed": true
}