Listing Cards

The List Cards endpoint is a search query: you filter your team's cards with Guru Query Language and get back the matching card objects. Reach for it when an integration needs a set of cards, whether that's an export, an audit, or a periodic sync.

GET /v1/search/query

Query parameters

All query parameters are optional.

Parameter	Description
`q`	A Guru Query Language query string specifying the filters to apply. URL encode the query to make it safe for inclusion as a query parameter.
`searchTerms`	Search terms found in the card title, content, and other properties.
`showArchived`	A boolean (`true` or `false`) indicating whether to show archived cards. If set to `true`, the `searchTerms` parameter is ignored.
`maxResults`	The maximum number of results to return. Cannot exceed `50`.
`sortField`	The field to sort results by. See the values below.
`sortOrder`	`asc` for ascending order or `desc` for descending order.

Sort fields

Value	Meaning
`lastModified`	The date the card was last modified. This is the default, with a default sort order of descending.
`lastModifiedBy`	The user that last modified the card.
`boardCount`	The number of folders the card is in. The field retains its legacy board naming.
`verificationState`	The trust status of the card (Trusted, NeedsVerification).
`copyCount`	The number of times the card has been copied.
`viewCount`	The number of times the card has been viewed.
`favoriteCount`	The number of times the card has been favorited.
`dateCreated`	The date the card was created.
`verificationInterval`	The frequency in days the card needs to be verified.
`verifier`	The user or group responsible for verifying the card.
`owner`	The user that created the card.
`lastVerifiedBy`	The user that last verified the card.
`lastVerified`	The date the card was last verified.
`popularity`	A Guru metric indicating how popular the card is.
`title`	The title of the card.

Sample request

To get up to 10 cards modified in the last 7 days, use the query lastModified < 7_days_ago (URL encoded in practice):

curl -u $GURU_USER:$GURU_TOKEN "https://api.getguru.com/api/v1/search/query?q=lastModified < 7_days_ago&maxResults=10"

Sample response

The response is an array of card objects, including title, content, ID, and other relevant card information. Results can be paged; see Pagination.