Skip to content

Search accounts with filters and pagination (M2M only)

GET
/customer/accounts/search
search
string
>= 1 characters
type
string
Allowed values: personal business
status
string
default: active
Allowed values: active suspended closed
createdAfter
string | null
createdBefore
string | null
page
integer
default: 1 >= 1
pageSize
integer
default: 25 >= 1 <= 100
sortBy
string
default: createdAt
Allowed values: createdAt name ownerName
sortOrder
string
default: desc
Allowed values: asc desc

Paginated list of accounts with owner details

object
results
required
Array<object>
object
id
required
string format: uuid
tenantId
required
string
name
required
string
type
required
string
Allowed values: personal business
status
required
string
metadata
required
object | null
createdAt
required
string | null
updatedAt
required
string | null
ownerFirstName
required
string | null
ownerLastName
required
string | null
ownerEmail
required
string | null
total
required
integer
page
required
integer
>= 1
pageSize
required
integer
>= 1
totalPages
required
integer

Validation error

object
code
required
string
message
required
string
errors
required
Array<object>
object
field
required
string
message
required
string

Unauthenticated — missing or invalid auth context

object
code
required
string
message
required
string

Forbidden — caller lacks the required permission

object
code
required
string
message
required
string

Internal error (e.g. database failure)

object
code
required
string
message
required
string