Get all business details

GET/api/v1/Businesses/get-all

Description

This endpoint allows you to retrieve details of all businesses.

Request

• Path: /api/v{version}/Businesses/get-all

• Headers:

  • Accept-Language: Change default response message language from English(en). Available languages fr,en

• Query Parameters:

  • UserId: (string, format: uuid, nullable) Filter by User ID.

  • TenantId: (string, format: uuid, nullable) Filter by Tenant ID.

  • IncorporationDate: (string, format: date-time, nullable) Filter by incorporation date.

  • SearchText: (string, nullable) Search text to filter the results.

  • TermsAndConditionsSignedAt: (string, format: date-time, nullable) Filter by terms and conditions signed at.

  • OrderBy: (string) Order by field.

  • Descending: (boolean, nullable) Sort the results in descending order.

  • PageNumber: (integer, format: int32) Page number for pagination.

  • PageSize: (integer, format: int32) Number of records per page.

  • version (path): API version.

Response

• Success (200): CreateBusinessResponseListPagedResponse

Response Example

jsonCopy codeHTTP/1.1 200 OK
{
  "totalRecords": 1,
  "pageNumber": 1,
  "pageSize": 10,
  "records": [
    {
      "id": "123",
      "name": "Sample Business",
      "email": "business@example.com",
      "phone": "123456789",
      "address": "123 Example St., Exampleville, EX, 12345"
    }
  ]
}

/api/v`{{version}}`/Businesses/get-all?UserId=<uuid>&TenantId=<uuid>&IncorporationDate=<dateTime>&SearchText=<string>&TermsAndConditionsSignedAt=<dateTime>&OrderBy=1&Decending=<boolean>&PageNumber=<integer>&PageSize=<integer>

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
UserId	<uuid>
TenantId	<uuid>
IncorporationDate	<dateTime>
SearchText	<string>
TermsAndConditionsSignedAt	<dateTime>
OrderBy	1
Decending	<boolean>
PageNumber	<integer>
PageSize	<integer>

Response: 200

{
  "pageNumber": `<integer>`,
  "pageSize": `<integer>`,
  "total": `<integer>`,
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": [
    {
      "address": {
        "addressLine1": `<string>`,
        "addressLine2": `<string>`,
        "state": `<string>`,
        "city": `<string>`,
        "zipCode": `<string>`
      },
      "id": `<uuid>`,
      "userId": `<uuid>`,
      "tenantId": `<uuid>`,
      "name": `<string>`,
      "incorporationDate": `<dateTime>`,
      "industry": `<string>`,
      "mobileNumber": `<string>`,
      "countryOfIncorporation": `<string>`,
      "incorporationType": `<string>`,
      "incorporationNumber": `<string>`,
      "websiteUrl": `<string>`,
      "termsAndConditionsSignedAt": `<dateTime>`,
      "clientId": `<integer>`
    },
    {
      "address": {
        "addressLine1": `<string>`,
        "addressLine2": `<string>`,
        "state": `<string>`,
        "city": `<string>`,
        "zipCode": `<string>`
      },
      "id": `<uuid>`,
      "userId": `<uuid>`,
      "tenantId": `<uuid>`,
      "name": `<string>`,
      "incorporationDate": `<dateTime>`,
      "industry": `<string>`,
      "mobileNumber": `<string>`,
      "countryOfIncorporation": `<string>`,
      "incorporationType": `<string>`,
      "incorporationNumber": `<string>`,
      "websiteUrl": `<string>`,
      "termsAndConditionsSignedAt": `<dateTime>`,
      "clientId": `<integer>`
    }
  ]
}