Sign in

v1

latestOpenAPI 3.0.12026-07-2471156164.1 KB
Collections

Find a collection by ID

get/api/v1/collections/{collectionId}

Path parameters

collectionIdstring required

The ID of the collection

Response

successful operation

namestring

Collection Name

readOnlyboolean
idstring

ID of the collection

colorstring

A hex value for the color of the Collection

emojistring
slugstring

The slug is the URL to get to this Collection

lastSyncedDatestring date-time

The date that the Collection was last synced from the source

topLevelSyncLocationstring

The URL where the content of the Collection is being synced from

publicCardsinteger
madeByGuruboolean
homeBoardSlugstring
syncType'ZENDESK' | 'ZENDESK_IMPORT' | 'CONFLUENCE' | 'MANUAL' | 'GOOGLE_DRIVE' | 'ZENEFITS' | 'BOX' | 'KUSTOMER' | 'DROPBOX' | 'SALESFORCE' | 'GURU'

If this Collection has been synced, this will return the type. Types include: Zendesk, Confluence, Google Drive, and Manual.

deletedboolean

Flag for whether this Collection has been deleted

defaultVerifierstring
boardsinteger

Number of boards in this Collection

dateCreatedstring date-time

Date the collection was created

collectionType'INTERNAL' | 'EXTERNAL'

The type can be either INTERNAL or EXTERNAL. EXTERNAL indicates that the card is from a synced Collection.

publicCardsEnabledboolean
syncVerificationEnabledboolean
collectionTypeDetail'ONBOARDING' | 'FRAMEWORK' | 'USER' | 'EXTERNAL' | 'SOURCE' | 'WELCOME' | 'ONBOARDING_UNEDITED'

The type can be FRAMEWORK, ONBOARDING, USER or EXTERNAL.

verificationIntervalinteger
cardsinteger

Number of cards in this Collection

administratorboolean
descriptionstring

Collection Description

tagsinteger

Returns all Tag objects associated with this collection

tokenstring