Businesses

PreviousTwo Factor Auth NextDemo

Last updated 5 months ago

Retrieves all active businesses for the user's team.

get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/businesses'

200

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

Businesses retrieved successfully

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/businesses/search?search=Business+Name'

200

429

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

Businesses retrieved successfully

Retrieves all archived businesses for the user's team.

get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/businesses/archived'

200

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

Archived businesses retrieved successfully

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

get

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/businesses/members-without-business'

200

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

Members retrieved successfully

Retrieves a business by its ID.

get

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/businesses/{id}'

200

400

404

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

Business retrieved successfully

Retrieves a photo for a business by its file name.

get

Path parameters

fileNamestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/businesses/get-photo/{fileName}'

200

404

binary

Photo retrieved successfully

Retrieves comments for a business by its ID.

get

Path parameters

idnumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/businesses/comments/{id}'

200

400

403

404

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

Comments retrieved successfully

Retrieves logs for a business by its ID.

get

Path parameters

idnumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/businesses/logs/{id}'

200

403

404

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

Logs retrieved successfully

Retrieves logs and comments for a business by its ID.

get

Path parameters

idnumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/businesses/logs-and-comments/{id}'

200

400

403

404

{
  "logsAndComments": [
    {
      "id": 1,
      "action": "CreateBusiness",
      "entityType": "Business",
      "user": {
        "id": 1,
        "email": "user@example.com"
      },
      "content": "This is a comment.",
      "createdAt": "2023-01-01T00:00:00Z"
    }
  ],
  "logsCount": 5,
  "commentsCount": 5
}

Logs and comments retrieved successfully

Deletes a photo for a business by its file name.

delete

Path parameters

fileNamestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/businesses/delete-photo/{fileName}'

200

404

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

Photo deleted successfully

Deletes a comment on a business.

delete

Path parameters

idnumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/businesses/comments/{id}'

200

400

403

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

Comment deleted successfully

Creates a new business.

post

Body

namestringrequired

Example: Business Name

addressobjectrequired

emailstringrequired

Example: business@example.com

descriptionstringrequired

Example: Business description

photostringrequired

Example: photo.jpg

phonesstring[]required

Example: ["123-456-7890"]

contactPersonnumberrequired

Example: 1

socialMediaobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/businesses' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Business Name",
    "address": {
      "addressOne": "123 Main St",
      "addressTwo": "Suite 100",
      "city": "Anytown",
      "country": "USA",
      "state": "CA",
      "zipCode": "12345"
    },
    "email": "business@example.com",
    "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"
    }
  }'

201

400

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

Business created successfully

Uploads a photo for a business.

post

Body

idnumberoptional

Example: 1

photostring · binaryoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/businesses/upload-photo' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 1,
    "photo": "binary"
  }'

200

400

formatted_file_name.jpg

Photo uploaded successfully

Leaves a comment on a business.

post

Path parameters

idnumberrequired

Body

contentstringoptional

Example: This is a comment.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/businesses/comments/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "content": "This is a comment."
  }'

201

400

403

404

{
  "id": 1,
  "content": "This is a comment.",
  "user": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "email": "user@example.com"
  },
  "createdAt": "2023-01-01T00:00:00Z"
}

Comment added successfully

Archives multiple businesses by their IDs.

patch

Body

idsnumber[]required

Example: [1,2,3]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/businesses/archive' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      1,
      2,
      3
    ]
  }'

200

400

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

Businesses archived successfully

Restores multiple archived businesses by their IDs.

patch

Body

idsnumber[]required

Example: [1,2,3]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/businesses/restore' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      1,
      2,
      3
    ]
  }'

200

400

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

Businesses restored successfully

Updates a business by its ID.

put

Path parameters

idstringrequired

Body

namestringrequired

Example: Business Name

addressobjectrequired

emailstringrequired

Example: business@example.com

descriptionstringrequired

Example: Business description

photostringrequired

Example: photo.jpg

phonesstring[]required

Example: ["123-456-7890"]

contactPersonnumberrequired

Example: 1

socialMediaobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/businesses/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Business Name",
    "address": {
      "addressOne": "123 Main St",
      "addressTwo": "Suite 100",
      "city": "Anytown",
      "country": "USA",
      "state": "CA",
      "zipCode": "12345"
    },
    "email": "business@example.com",
    "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"
    }
  }'

200

400

404

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

Business updated successfully

Edits a comment on a business.

put

Path parameters

idnumberrequired

Body

contentstringoptional

Example: This is an edited comment.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/businesses/comments/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "content": "This is an edited comment."
  }'

200

400

403

404

{
  "id": 1,
  "content": "This is an edited comment.",
  "user": {
    "id": 1,
    "firstName": "John",
    "lastName": "Doe",
    "email": "user@example.com"
  },
  "createdAt": "2023-01-01T00:00:00Z"
}

Comment edited successfully

Deletes multiple businesses by their IDs.

delete

Body

idsnumber[]required

Example: [1,2,3]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/businesses' \
  --header 'Content-Type: application/json' \
  --data '{
    "ids": [
      1,
      2,
      3
    ]
  }'

200

400

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

Businesses deleted successfully

Businesses

Businesses

GET

POST

PATCH

PUT

DELETE

GET

POST

PATCH

PUT

DELETE

Retrieves all active businesses for the user's team.

Searches for businesses based on the provided search term.

Retrieves all archived businesses for the user's team.

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

Retrieves a business by its ID.

Retrieves a photo for a business by its file name.

Retrieves comments for a business by its ID.

Retrieves logs for a business by its ID.

Retrieves logs and comments for a business by its ID.

Deletes a photo for a business by its file name.

Deletes a comment on a business.

Creates a new business.

Uploads a photo for a business.

Leaves a comment on a business.

Archives multiple businesses by their IDs.

Restores multiple archived businesses by their IDs.

Updates a business by its ID.

Edits a comment on a business.

Deletes multiple businesses by their IDs.

GET

POST

PATCH

PUT

DELETE

GET

POST

PATCH

PUT

DELETE

Retrieves all active businesses for the user's team.

Searches for businesses based on the provided search term.

Retrieves all archived businesses for the user's team.

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

Retrieves a business by its ID.

Retrieves a photo for a business by its file name.

Retrieves comments for a business by its ID.

Retrieves logs for a business by its ID.

Retrieves logs and comments for a business by its ID.

Deletes a photo for a business by its file name.

Deletes a comment on a business.

Creates a new business.

Show child attributes

Show child attributes

Uploads a photo for a business.

Leaves a comment on a business.

Archives multiple businesses by their IDs.

Restores multiple archived businesses by their IDs.

Updates a business by its ID.

Show child attributes

Show child attributes

Edits a comment on a business.

Deletes multiple businesses by their IDs.