Businesses

GET

Retrieves all active businesses for the user's team.

GET/businesses

Response

200

Businesses retrieved successfully

Body

application/json

countnumber

Example: 10

businessesarray of object

Request

JavaScriptCurlPython

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

Response

200

{
  "count": 10,
  "businesses": [
    {
      "id": 1,
      "name": "Business Name",
      "phones": [
        "123-456-7890"
      ],
      "email": "[e-mail]",
      "contactPerson": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "photo": "https://example.com/photo.jpg"
      },
      "team": {
        "id": "team_id"
      }
    }
  ]
}

Searches for businesses based on the provided search term.

GET/businesses/search

Query parameters

Response

200429

Businesses retrieved successfully

Body

application/json

idnumber

Example: 1

namestring

Example: "Business Name"

phonesarray of string

emailstring

Example: "[e-mail]"

contactPersonobject

teamobject

Request

JavaScriptCurlPython

const response = await fetch('/businesses/search?search=Business+Name', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200429

[
  {
    "id": 1,
    "name": "Business Name",
    "phones": [
      "123-456-7890"
    ],
    "email": "[e-mail]",
    "contactPerson": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "photo": "https://example.com/photo.jpg"
    },
    "team": {
      "id": "team_id"
    }
  }
]

Retrieves all archived businesses for the user's team.

GET/businesses/archived

Response

200

Archived businesses retrieved successfully

Body

application/json

countnumber

Example: 5

businessesarray of object

Request

JavaScriptCurlPython

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

Response

200

{
  "count": 5,
  "businesses": [
    {
      "id": 1,
      "name": "Business Name",
      "phones": [
        "123-456-7890"
      ],
      "email": "[e-mail]",
      "contactPerson": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe",
        "photo": "https://example.com/photo.jpg"
      },
      "team": {
        "id": "team_id"
      }
    }
  ]
}

Retrieves all team members who are not associated with any business.

GET/businesses/members-without-business

Response

200

Members retrieved successfully

Body

application/json

countnumber

Example: 5

usersarray of object

Request

JavaScriptCurlPython

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

Response

200

{
  "count": 5,
  "users": [
    {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumber": "123-456-7890",
      "email": "[e-mail]",
      "teamRole": "Member",
      "membershipId": 1,
      "isActive": true,
      "isDeleted": false,
      "deletedAt": "2023-01-01T00:00:00Z"
    }
  ]
}

Retrieves a business by its ID.

GET/businesses/{id}

Path parameters

id*string

Response

200400404

Business retrieved successfully

Body

application/json

idnumber

Example: 1

namestring

Example: "Business Name"

phonesarray of string

emailstring

Example: "[e-mail]"

contactPersonobject

teamobject

Request

JavaScriptCurlPython

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

Response

200400404

{
  "id": 1,
  "name": "Business Name",
  "phones": [
    "123-456-7890"
  ],
  "email": "[e-mail]",
  "contactPerson": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "photo": "https://example.com/photo.jpg"
  },
  "team": {
    "id": "team_id"
  }
}

Retrieves a photo for a business by its file name.

GET/businesses/get-photo/{fileName}

Path parameters

fileName*string

Response

200404

Photo retrieved successfully

Body

application/json

string (binary)

Request

JavaScriptCurlPython

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

Response

200404

binary

Retrieves comments for a business by its ID.

GET/businesses/comments/{id}

Path parameters

id*number

Response

200400403404

Comments retrieved successfully

Body

application/json

countnumber

Example: 5

commentsarray of object

Request

JavaScriptCurlPython

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

Response

200400403404

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

Retrieves logs for a business by its ID.

GET/businesses/logs/{id}

Path parameters

id*number

Response

200403404

Logs retrieved successfully

Body

application/json

countnumber

Example: 5

logsarray of object

Request

JavaScriptCurlPython

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

Response

200403404

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

Retrieves logs and comments for a business by its ID.

GET/businesses/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('/businesses/logs-and-comments/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "logsAndComments": [
    {
      "id": 1,
      "action": "CreateBusiness",
      "entityType": "Business",
      "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 business.

POST/businesses

Body

application/json

Business creation data

name*string

Name of the business

Example: "Business Name"

address*object

Address of the business

email*string

Email of the business

Example: "[e-mail]"

description*nullable string

Description of the business

Example: "Business description"

photo*nullable string

Photo of the business

Example: "photo.jpg"

phones*array of string

Phone numbers of the business

contactPerson*nullable number

Contact person ID for the business

Example: 1

socialMedia*object

Social media links of the business

Response

201400

Business created successfully

Body

application/json

idnumber

Example: 1

namestring

Example: "Business Name"

phonesarray of string

emailstring

Example: "[e-mail]"

contactPersonobject

teamobject

Request

JavaScriptCurlPython

const response = await fetch('/businesses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Business Name",
      "address": {},
      "email": "[e-mail]",
      "description": "Business description",
      "photo": "photo.jpg",
      "phones": [
        "123-456-7890"
      ],
      "contactPerson": 1,
      "socialMedia": {}
    }),
});
const data = await response.json();

Response

201400

{
  "id": 1,
  "name": "Business Name",
  "phones": [
    "123-456-7890"
  ],
  "email": "[e-mail]",
  "contactPerson": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "photo": "https://example.com/photo.jpg"
  },
  "team": {
    "id": "team_id"
  }
}

Uploads a photo for a business.

POST/businesses/upload-photo

Body

application/json

Photo upload data

idnumber

Example: 1

photostring (binary)

Response

200400

Photo uploaded successfully

Body

application/json

string

Example: "formatted_file_name.jpg"

Request

JavaScriptCurlPython

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

Response

200400

formatted_file_name.jpg

Leaves a comment on a business.

POST/businesses/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('/businesses/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 businesses by their IDs.

PATCH/businesses/archive

Body

application/json

Array of business IDs to archive

ids*array of number

Array of IDs

Response

200400

Businesses archived successfully

Body

application/json

idnumber

Example: 1

namestring

Example: "Business Name"

phonesarray of string

emailstring

Example: "[e-mail]"

contactPersonobject

teamobject

Request

JavaScriptCurlPython

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

Response

200400

[
  {
    "id": 1,
    "name": "Business Name",
    "phones": [
      "123-456-7890"
    ],
    "email": "[e-mail]",
    "contactPerson": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "photo": "https://example.com/photo.jpg"
    },
    "team": {
      "id": "team_id"
    }
  }
]

Restores multiple archived businesses by their IDs.

PATCH/businesses/restore

Body

application/json

Array of business IDs to restore

ids*array of number

Array of IDs

Response

200400

Businesses restored successfully

Body

application/json

idnumber

Example: 1

namestring

Example: "Business Name"

phonesarray of string

emailstring

Example: "[e-mail]"

contactPersonobject

teamobject

Request

JavaScriptCurlPython

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

Response

200400

[
  {
    "id": 1,
    "name": "Business Name",
    "phones": [
      "123-456-7890"
    ],
    "email": "[e-mail]",
    "contactPerson": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "photo": "https://example.com/photo.jpg"
    },
    "team": {
      "id": "team_id"
    }
  }
]

PUT

Updates a business by its ID.

PUT/businesses/{id}

Path parameters

id*string

Body

application/json

Business update data

name*string

Name of the business

Example: "Business Name"

address*object

Address of the business

email*string

Email of the business

Example: "[e-mail]"

description*nullable string

Description of the business

Example: "Business description"

photo*nullable string

Photo of the business

Example: "photo.jpg"

phones*array of string

Phone numbers of the business

contactPerson*nullable number

Contact person ID for the business

Example: 1

socialMedia*object

Social media links of the business

Response

200400404

Business updated successfully

Body

application/json

idnumber

Example: 1

namestring

Example: "Updated Business Name"

phonesarray of string

emailstring

Example: "[e-mail]"

contactPersonobject

teamobject

Request

JavaScriptCurlPython

const response = await fetch('/businesses/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Business Name",
      "address": {},
      "email": "[e-mail]",
      "description": "Business description",
      "photo": "photo.jpg",
      "phones": [
        "123-456-7890"
      ],
      "contactPerson": 1,
      "socialMedia": {}
    }),
});
const data = await response.json();

Response

200400404

{
  "id": 1,
  "name": "Updated Business Name",
  "phones": [
    "123-456-7890"
  ],
  "email": "[e-mail]",
  "contactPerson": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "photo": "https://example.com/photo.jpg"
  },
  "team": {
    "id": "team_id"
  }
}

Edits a comment on a business.

PUT/businesses/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('/businesses/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 businesses by their IDs.

DELETE/businesses

Body

application/json

Array of business IDs to delete

ids*array of number

Array of IDs

Response

200400

Businesses deleted successfully

Body

application/json

idnumber

Example: 1

namestring

Example: "Business Name"

phonesarray of string

emailstring

Example: "[e-mail]"

contactPersonobject

teamobject

Request

JavaScriptCurlPython

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

Response

200400

[
  {
    "id": 1,
    "name": "Business Name",
    "phones": [
      "123-456-7890"
    ],
    "email": "[e-mail]",
    "contactPerson": {
      "id": 1,
      "firstName": "John",
      "lastName": "Doe",
      "photo": "https://example.com/photo.jpg"
    },
    "team": {
      "id": "team_id"
    }
  }
]

Deletes a photo for a business by its file name.

DELETE/businesses/delete-photo/{fileName}

Path parameters

fileName*string

Response

200404

Photo deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/businesses/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 comment on a business.

DELETE/businesses/comments/{id}

Path parameters

id*number

Response

200400403

Comment deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

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

Response

200400403

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