Skip to main content
GET
List business cases

Authorizations

Authorization
string
header
required

Bearer token created for a specific company in Integrations → API.

Query Parameters

clientId
integer

Filter by a client. This field is mutually exclusive with supplierId.

Example:

101

supplierId
integer

Filter by a supplier. This field is mutually exclusive with clientId.

Example:

151

statusId
integer | null

Filter by a business-case status.

Example:

41

Full-text search by business-case name or description.

Maximum string length: 255
Example:

"keyword"

sortBy
enum<string>
default:id

Field used to sort business cases.

Available options:
name,
createdAt,
updatedAt,
boardPosition
Example:

"updatedAt"

sortDirection
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
Example:

"desc"

perPage
integer
default:10

Number of results per page. Maximum is 200.

Required range: 1 <= x <= 200
Example:

10

page
integer
default:1

Page number to return.

Required range: x >= 1
Example:

1

Response

Business-case list.

data
object[]

List of business cases.

paginator
object

Paginator for the current result set.