Skip to main content
GET
Search cards on the board

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Path Parameters

boardId
integer
required

Query Parameters

page
integer
default:1

Page number, starting at 1. An invalid value is treated as 1.

Required range: x >= 1
perPage
integer
default:20

Number of items per page. The maximum depends on the environment (default 100).

Required range: 1 <= x <= 100

Searches the card's name and description, ignoring upper and lower case.

crmBoardListId
integer

Only cards in this board stage.

assignedToUserId
integer

Only cards assigned to this user.

crmOriginId
integer

Only cards from this origin.

crmBusinessId
integer

Only cards linked to this business.

crmBoardCardStatusId
integer

Only cards with this status. Statuses are configured on each stage.

contactId
integer

Only cards linked to this contact.

won
boolean

true returns only won cards and false only cards not won. Without the parameter, both are returned.

creationSource
enum<string>

Filters by how the card was created. Who created the record:

Available options:
api,
user,
bot,
automation
createdFrom
string<date-time>

Only cards created from this date on. The day starts in your company's time zone.

createdTo
string<date-time>

Only cards created up to this date. The day ends at 23:59:59 in your company's time zone.

dueFrom
string<date-time>

Only cards due from this date on. The day starts in your company's time zone.

dueTo
string<date-time>

Only cards due up to this date. The day ends at 23:59:59 in your company's time zone.

orderBy
enum<string>
default:createdAt

Field used to sort the list. An unknown value falls back to the default. Field used to sort:

Available options:
createdAt,
updatedAt,
due,
position,
name
order
enum<string>
default:desc

Sort direction: asc ascending, desc descending. Sort direction:

Available options:
asc,
desc

Response

OK

data
object[]
meta
object
Example: