---
title: "List collections"
method: GET
path: "/api/v1/collections"
tags: ["Collections"]
---

# List collections

`GET /api/v1/collections`

Returns all undeleted collections accessible to the authenticated user

## Query parameters

- `search` string
- `sortField` string
- `sortDir` string
- `filter` string

## Response `200`

successful operation

- CollectionModel[]
  - `name` string — Collection Name
  - `readOnly` boolean
  - `id` string — ID of the collection
  - `color` string — A hex value for the color of the Collection
  - `emoji` string
  - `slug` string — The slug is the URL to get to this Collection
  - `collectionStats` CollectionStats
    - `stats` object — Returns an object that includes the Collection Trust Score, and Card Count of the Collection.
  - `lastSyncedDate` string, date-time — The date that the Collection was last synced from the source
  - `topLevelSyncLocation` string — The URL where the content of the Collection is being synced from
  - `publicCards` integer
  - `madeByGuru` boolean
  - `homeBoardSlug` string
  - `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.
  - `deleted` boolean — Flag for whether this Collection has been deleted
  - `team` Team
    - `name` string — Team Name
    - `id` string — ID of the fact
    - `profilePicUrl` string
    - `companyName` string — Team Company Name
    - `currentUserIsMember` boolean
    - `domain` string — Domain
    - `edition` TeamEdition
      - `adminOverrides` object
      - `name` string
      - `key` string
      - `id` string
      - `usage` object
      - `code` string
      - `features` object
    - `billableUsers` integer
    - `totalUsers` integer
    - `teamDomains` TeamDomain[]
      - `verificationCode` string
      - `verified` boolean
      - `capture` boolean
      - `domain` string
    - `slackCommandState` string
    - `slackCommandInstalled` boolean
    - `sfdcIntegrationState` string
    - `sfdcIntegrationInstalled` boolean
    - `clearProfilePic` boolean
    - `defaultGroup` UserGroup
      - `name` string — Group Name
      - `id` string — ID of the group
      - `members` UserGroupMember[]
        - `id` string — ID of the group member
        - `managedByScim` boolean
        - `dateCreated` string, date-time — Date the group member was added to the group. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000
        - `user` User, required
          - `id` string — The identifier of this User
          - `profilePicUrl` string — The profile picture url for the user
          - `joinedDate` string, date-time
          - `userProfile` UserProfile — Specifies additional information about a Guru User
            - `roleLevel` string — The level at which the user operates in their current role
            - `useCaseList` UseCase[] — Describes different ways the user intends to use Guru
              - …
            - `role` string — The functional role a Guru user performs on their team
          - `lastName` string, required — The user's last name
          - `firstName` string, required — The user's first name
          - `status` 'ACTIVE' | 'PENDING' — The status of a User can be ACTIVE or PENDING. The User must verify their email address to be considered ACTIVE.
          - `email` string, required — The user's email address
      - `expertIdRank` integer
      - `numberOfCardsAsVerifier` integer
      - `managedByScim` boolean
      - `groupIdentifier` string
      - `numberOfMembers` integer
      - `modifiable` boolean
      - `userModifiable` boolean
      - `singleUser` boolean
      - `team` Team — recursive
      - `dateCreated` string, date-time — Date the group was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000
      - `role` 'ADMIN' | 'AUTHOR' | 'MEMBER' | 'COLL_ADMIN'
    - `defaultUserType` 'FREE_CORE' | 'CORE'
    - `trialExpirationDate` string, date-time
    - `zendeskAssistState` string
    - `zendeskAssistInstalled` boolean
    - `zendeskKnowledgeState` string
    - `zendeskKnowledgeInstalled` boolean
    - `fileSharingDisabled` boolean
    - `collectionCreated` boolean
    - `teamCreationToken` string
    - `cardsCreated` integer
    - `topLevelOrganizationId` string
    - `numberOfCollections` integer
    - `numberOfOrgSharedCollections` integer
    - `allMembersGroupId` string
    - `deleted` boolean — Indicates if the fact has been deleted
    - `dateCreated` string, date-time — Date the team was created. Dates are in ISO-8601 format. Example date (January 2nd 2014 12pm UTC): 2014-01-02T12:00:00.000+0000
    - `userRole` string
    - `useCase` string
    - `description` string
    - `status` 'ACTIVE' | 'DORMANT' | 'LOCKED' | 'EXPIRED' | 'LOCKED_PAY'
    - `organization` Organization
      - `name` string
      - `id` string
      - `workspaces` Team[]
  - `defaultVerifier` string
  - `boards` integer — Number of boards in this Collection
  - `dateCreated` string, 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.
  - `publicCardsEnabled` boolean
  - `syncVerificationEnabled` boolean
  - `collectionTypeDetail` 'ONBOARDING' | 'FRAMEWORK' | 'USER' | 'EXTERNAL' | 'SOURCE' | 'WELCOME' | 'ONBOARDING_UNEDITED' — The type can be FRAMEWORK, ONBOARDING, USER or EXTERNAL.
  - `verificationInterval` integer
  - `cards` integer — Number of cards in this Collection
  - `administrator` boolean
  - `description` string — Collection Description
  - `tags` integer — Returns all Tag objects associated with this collection
  - `token` string

## Other responses

- `400` — Invalid/Incomplete Request
- `401` — Request was unauthorized
- `403` — Forbidden access to the resource
- `404` — Resource could not be found

---

[API](https://skmtc.net/getguru/apis/guru-api.md) · [All operations](https://skmtc.net/getguru/apis/guru-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getguru/guru-api/revisions/9090a01dfe1a/schema)