Skip to content
AnyBiz Documentation

List all business partners

GET
/settings/business-partners

Retrieve a paginated list of business partners (customers and suppliers) with filtering and sorting

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page
Any of:
number
pageSize
Any of:
number
sortBy
string
sortOrder
Allowed values: asc desc
search
string
filters
Array<object>
object
column
required
string
operator
required
Allowed values: equals contains startsWith endsWith gt gte lt lte in between
value
required
Any of:
string
dataType
required
Allowed values: string number date enum boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

object
data
required
Array<object>
object
id
required
string
organizationId
required
string
type
required
string
name
required
string
companyId
Any of:
string
tin
Any of:
string
address
Any of:
string
email
Any of:
string
phone
Any of:
string
createdAt
required
Any of:
updatedAt
required
Any of:
total
required
number
page
required
number
pageSize
required
number

401

Section titled “401 ”

401

One of:
object
defined
required
code
required
Allowed value: UNAUTHORIZED
status
required
Allowed value: 401
message
required
string
default: Missing user session. Please log in!
data

403

Section titled “403 ”

403

One of:
object
defined
required
code
required
Allowed value: FORBIDDEN
status
required
Allowed value: 403
message
required
string
default: You do not have enough permission to perform this action.
data

422

Section titled “422 ”

422

One of:
object
defined
required
code
required
Allowed value: INPUT_VALIDATION_FAILED
status
required
Allowed value: 422
message
required
string
default: INPUT_VALIDATION_FAILED
data