Businesses

GET

Retrieves all active businesses for the user's team.

get

Responses

200

Businesses retrieved successfully

application/json

countnumberOptionalExample: 10

get

/businesses

HTTPcURLJavaScriptPython

GET /businesses HTTP/1.1
Accept: */*

200

Businesses retrieved successfully

{
  "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

Query parameters

searchstringRequired

The search term to use for finding businesses.

Example: Business Name

Responses

200

Businesses retrieved successfully

application/json

idnumberOptionalExample: 1

namestringOptionalExample: Business Name

phonesstring[]OptionalExample: ["123-456-7890"]

emailstringOptionalExample: [e-mail]

429

Too many requests

application/json

get

/businesses/search

HTTPcURLJavaScriptPython

GET /businesses/search?search=Business+Name HTTP/1.1
Accept: */*

[
  {
    "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

Responses

200

Archived businesses retrieved successfully

application/json

countnumberOptionalExample: 5

get

/businesses/archived

HTTPcURLJavaScriptPython

GET /businesses/archived HTTP/1.1
Accept: */*

200

Archived businesses retrieved successfully

{
  "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

Responses

200

Members retrieved successfully

application/json

countnumberOptionalExample: 5

get

/businesses/members-without-business

HTTPcURLJavaScriptPython

GET /businesses/members-without-business HTTP/1.1
Accept: */*

200

Members retrieved successfully

{
  "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

Path parameters

idstringRequired

Responses

200

Business retrieved successfully

application/json

idnumberOptionalExample: 1

namestringOptionalExample: Business Name

phonesstring[]OptionalExample: ["123-456-7890"]

emailstringOptionalExample: [e-mail]

400

Invalid ID

application/json

404

Business not found

application/json

get

/businesses/{id}

HTTPcURLJavaScriptPython

GET /businesses/{id} HTTP/1.1
Accept: */*

{
  "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

Path parameters

fileNamestringRequired

Responses

200

Photo retrieved successfully

application/json

string · binaryOptional

404

Photo not found

application/json

get

/businesses/get-photo/{fileName}

HTTPcURLJavaScriptPython

GET /businesses/get-photo/{fileName} HTTP/1.1
Accept: */*

binary

Retrieves comments for a business by its ID.

get

Path parameters

idnumberRequired

Responses

200

Comments retrieved successfully

application/json

countnumberOptionalExample: 5

400

Invalid business ID

application/json

403

Access denied

application/json

404

Business not found

application/json

get

/businesses/comments/{id}

HTTPcURLJavaScriptPython

GET /businesses/comments/{id} HTTP/1.1
Accept: */*

{
  "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

Path parameters

idnumberRequired

Responses

200

Logs retrieved successfully

application/json

countnumberOptionalExample: 5

403

Access denied

application/json

404

Business not found

application/json

get

/businesses/logs/{id}

HTTPcURLJavaScriptPython

GET /businesses/logs/{id} HTTP/1.1
Accept: */*

{
  "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

Path parameters

idnumberRequired

Responses

200

Logs and comments retrieved successfully

application/json

logsCountnumberOptionalExample: 5

commentsCountnumberOptionalExample: 5

400

Invalid business ID

application/json

403

Access denied

application/json

404

Business not found

application/json

get

/businesses/logs-and-comments/{id}

HTTPcURLJavaScriptPython

GET /businesses/logs-and-comments/{id} HTTP/1.1
Accept: */*

{
  "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

Body

application/json

namestringRequiredExample: Business Name

emailstringRequiredExample: [e-mail]

descriptionstringRequiredExample: Business description

photostringRequiredExample: photo.jpg

phonesstring[]RequiredExample: ["123-456-7890"]

contactPersonnumberRequiredExample: 1

Responses

201

Business created successfully

application/json

400

Phones must be unique

application/json

post

/businesses

HTTPcURLJavaScriptPython

POST /businesses HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 438

{
  "name": "Business Name",
  "address": {
    "addressOne": "123 Main St",
    "addressTwo": "Suite 100",
    "city": "Anytown",
    "country": "USA",
    "state": "CA",
    "zipCode": "12345"
  },
  "email": "[e-mail]",
  "description": "Business description",
  "photo": "photo.jpg",
  "phones": [
    "123-456-7890"
  ],
  "contactPerson": 1,
  "socialMedia": {
    "youtube": "youtube.com/business",
    "facebook": "facebook.com/business",
    "instagram": "instagram.com/business",
    "twitter": "twitter.com/business"
  }
}

{
  "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

Body

application/json

idnumberOptionalExample: 1

photostring · binaryOptional

Responses

200

Photo uploaded successfully

application/json

stringOptionalExample: formatted_file_name.jpg

400

Invalid file

application/json

post

/businesses/upload-photo

HTTPcURLJavaScriptPython

POST /businesses/upload-photo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "id": 1,
  "photo": "binary"
}

formatted_file_name.jpg

Leaves a comment on a business.

post

Path parameters

idnumberRequired

Body

application/json

contentstringOptionalExample: This is a comment.

Responses

201

Comment added successfully

application/json

400

Invalid business ID

application/json

403

Access denied

application/json

404

Business not found

application/json

post

/businesses/comments/{id}

HTTPcURLJavaScriptPython

POST /businesses/comments/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "content": "This is a comment."
}

{
  "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

Body

application/json

idsnumber[]RequiredExample: [1,2,3]

Responses

200

Businesses archived successfully

application/json

idnumberOptionalExample: 1

namestringOptionalExample: Business Name

phonesstring[]OptionalExample: ["123-456-7890"]

emailstringOptionalExample: [e-mail]

400

One or more businesses not found

application/json

patch

/businesses/archive

HTTPcURLJavaScriptPython

PATCH /businesses/archive HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "ids": [
    1,
    2,
    3
  ]
}

[
  {
    "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

Body

application/json

idsnumber[]RequiredExample: [1,2,3]

Responses

200

Businesses restored successfully

application/json

idnumberOptionalExample: 1

namestringOptionalExample: Business Name

phonesstring[]OptionalExample: ["123-456-7890"]

emailstringOptionalExample: [e-mail]

400

One or more businesses not found

application/json

patch

/businesses/restore

HTTPcURLJavaScriptPython

PATCH /businesses/restore HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "ids": [
    1,
    2,
    3
  ]
}

[
  {
    "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

Path parameters

idstringRequired

Body

application/json

namestringRequiredExample: Business Name

emailstringRequiredExample: [e-mail]

descriptionstringRequiredExample: Business description

photostringRequiredExample: photo.jpg

phonesstring[]RequiredExample: ["123-456-7890"]

contactPersonnumberRequiredExample: 1

Responses

200

Business updated successfully

application/json

idnumberOptionalExample: 1

namestringOptionalExample: Updated Business Name

phonesstring[]OptionalExample: ["123-456-7890"]

emailstringOptionalExample: [e-mail]

400

Invalid ID

application/json

404

Business not found

application/json

put

/businesses/{id}

HTTPcURLJavaScriptPython

PUT /businesses/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 438

{
  "name": "Business Name",
  "address": {
    "addressOne": "123 Main St",
    "addressTwo": "Suite 100",
    "city": "Anytown",
    "country": "USA",
    "state": "CA",
    "zipCode": "12345"
  },
  "email": "[e-mail]",
  "description": "Business description",
  "photo": "photo.jpg",
  "phones": [
    "123-456-7890"
  ],
  "contactPerson": 1,
  "socialMedia": {
    "youtube": "youtube.com/business",
    "facebook": "facebook.com/business",
    "instagram": "instagram.com/business",
    "twitter": "twitter.com/business"
  }
}

{
  "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

Path parameters

idnumberRequired

Body

application/json

contentstringOptionalExample: This is an edited comment.

Responses

200

Comment edited successfully

application/json

idnumberOptionalExample: 1

contentstringOptionalExample: This is an edited comment.

createdAtstring · date-timeOptionalExample: 2023-01-01T00:00:00Z

400

Invalid comment ID

application/json

403

Access denied

application/json

404

Comment not found

application/json

put

/businesses/comments/{id}

HTTPcURLJavaScriptPython

PUT /businesses/comments/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "content": "This is an edited comment."
}

{
  "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

Body

application/json

idsnumber[]RequiredExample: [1,2,3]

Responses

200

Businesses deleted successfully

application/json

idnumberOptionalExample: 1

namestringOptionalExample: Business Name

phonesstring[]OptionalExample: ["123-456-7890"]

emailstringOptionalExample: [e-mail]

400

One or more businesses not found

application/json

delete

/businesses

HTTPcURLJavaScriptPython

DELETE /businesses HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "ids": [
    1,
    2,
    3
  ]
}

[
  {
    "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

Path parameters

fileNamestringRequired

Responses

200

Photo deleted successfully

application/json

anyOptionalExample: {"message":"Photo deleted successfully","description":"The photo has been deleted successfully."}

404

Photo not found

application/json

delete

/businesses/delete-photo/{fileName}

HTTPcURLJavaScriptPython

DELETE /businesses/delete-photo/{fileName} HTTP/1.1
Accept: */*

{
  "message": "Photo deleted successfully",
  "description": "The photo has been deleted successfully."
}

Deletes a comment on a business.

delete

Path parameters

idnumberRequired

Responses

200

Comment deleted successfully

application/json

anyOptionalExample: {"message":"Comment deleted successfully","description":"The comment has been deleted successfully."}

400

Invalid comment ID

application/json

403

Access denied

application/json

delete

/businesses/comments/{id}

HTTPcURLJavaScriptPython

DELETE /businesses/comments/{id} HTTP/1.1
Accept: */*

{
  "message": "Comment deleted successfully",
  "description": "The comment has been deleted successfully."
}