listCards( )

Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.

Retrieves a list of a workflow's cards.

The listCards() function returns a Promise that resolves to a list of the the specified workflow's cards.

Use the options parameter to specify which cards to retrieve and in which order to retrieve them. Must use either phaseId or fetchOnlyArchived. Cards can be sorted based on their "id", "name", "phaseId", "createdDate", "updatedDate", "source", and "position". If no limit parameter is passed, the first 50 cards are returned. Sort order defaults to by "phaseId" and then by "position" ascending.

This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.

Method Declaration
Method Parameters

ID of the workflow to retrieve cards from.


Options to use when retrieving the list of cards.

Return Type:Promise<CardList>
Was this helpful?