List business types

GET 
/BusinessType

List business types

Request

Query Parameters

page int32

Possible values: >= 1 and <= 2147483647

The 1-based page number for paginated results.

count int32

Possible values: >= 1 and <= 50

The number of items to return per page (1–50).

sortByProperty string

The property name to sort results by.

sortByAscending boolean

When true, sorts results in ascending order; descending otherwise.

searchValues object

Key-value pairs used to filter results.

findCodeToIncludeInPage string

A specific code to locate; the page containing it will be returned.

searchHistoricData boolean

When true, includes soft-deleted or historical records in the results.

Responses

200

A paginated list of business types.

application/json

Schema

Schema

• Array [
businessTypeCode stringnullablerequired

The code identifying the customer's business type.

businessTypeTitle stringnullablerequired

The display title of the business type.

createInfo object

Audit metadata capturing who created this record and when.

actionBy stringnullablerequired

The username or identifier of the user who performed the action.

actionAt date-timerequired

The date and time when the action was performed.

updateInfo object

Audit metadata capturing who last updated this record and when.

actionBy stringnullablerequired

The username or identifier of the user who performed the action.

actionAt date-timerequired

The date and time when the action was performed.

• ]

Example (from schema)

[
  {
    "businessTypeCode": "string",
    "businessTypeTitle": "string",
    "createInfo": {
      "actionBy": "string",
      "actionAt": "2024-07-29T15:51:28.071Z"
    },
    "updateInfo": {
      "actionBy": "string",
      "actionAt": "2024-07-29T15:51:28.071Z"
    }
  }
]

400

The request is invalid.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

404

No business types were found.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

500

Internal server error.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...