Skip to content

Query Object Board Groups

POST
/objects/{object_slug}/views/board/groups

Read status groups and full filtered counts. This POST performs no writes.

Authorizations

Parameters

Path Parameters

object_slug
required
string

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
columns
Any of:
Array<string>
<= 200 items
filters
Array<object>
<= 10 items

Filter parameters for listing records.

object
attribute_slug
required
string
operator
required
string
Allowed values: eq ne gt gte lt lte contains starts_with in is_null is_not_null
value
Any of:
groupBy
Any of:
string
includeArchived
boolean
layout
string
default: table
Allowed values: table board
search
string
"" <= 200 characters
sortBy
Any of:
string
sortOrder
string
default: desc
Allowed values: asc desc
version
integer
default: 1

Responses

200

Successful Response

object
data
required
Array<object>
object
label
required
string
total
required
integer
value
required
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string