Collections

In Cerby, collections are groups of accounts, secrets, and subcollections created to organize and categorize saved items. A collection object contains information about the collection label, the number of accounts and secrets within it, the dates when the collection was created and last updated, and the user who created and last updated the collection and their role.

A collection object is created in Cerby when you perform any of the following actions

• Add a collection manually through the Cerby web app.

• Import vaults or folders from your password manager.

With the Cerby API, you can retrieve all collections or specific collections by providing their ID. To learn more about collections, refer to the Collections article collection on the Cerby Help Center.

List collections

get

With a GET request to the /collections endpoint, you can retrieve a list of all your collections in your Cerby workspace.

Important: The API scope required to use this endpoint is: Item data.

Query parameters

page[number]integer · min: 1Optional

The page number to retrieve in the paginated result set.

Default: 1

page[size]integer · min: 1 · max: 100Optional

The number of items to return per page.

Default: 25

Responses

200

OK

application/json

401

Unauthorized - User is not authorized to perform the request.

application/json

404

Not found - Resource not found.

application/json

get

/collections

HTTPcURLJavaScriptPython

GET /api/v1/collections HTTP/1.1
Host: my-workspace.cerby.com
Accept: */*

{
  "data": [
    {
      "id": "2e376b17-1234-1234-8f72-4bb7d931abcd",
      "type": "collections",
      "attributes": {
        "createdAt": "2024-07-12T23:10:27+00:00",
        "createdBy": "1cc381f7-1234-1234-ac7b-ae3cd6d1abcd",
        "meta": {},
        "name": "Employee",
        "roles": [
          "collection_owner"
        ],
        "status": "enabled",
        "updatedAt": "2024-07-12T23:10:27+00:00",
        "updatedBy": "1cc381f7-1234-1234-ac7b-ae3cd6d1abcd"
      }
    },
    {
      "id": "f4e74ed1-1234-1234-b29e-253e3f42abcd",
      "type": "collections",
      "attributes": {
        "createdAt": "2024-07-12T23:10:57+00:00",
        "createdBy": "1cc381f7-1234-1234-ac7b-ae3cd6d1abcd",
        "meta": {},
        "name": "Employee",
        "roles": [
          "collection_owner"
        ],
        "status": "enabled",
        "updatedAt": "2024-07-12T23:10:58+00:00",
        "updatedBy": "1cc381f7-1234-1234-ac7b-ae3cd6d1abcd"
      }
    },
    {
      "id": "7a089968-35d2-461a-9adc-01600e0cdf8d",
      "type": "collections",
      "attributes": {
        "createdAt": "2024-07-09T02:30:52+00:00",
        "createdBy": "1cc381f7-1234-1234-ac7b-ae3cd6d1abcd",
        "meta": {},
        "name": "Employee (2)",
        "roles": [
          "collection_owner"
        ],
        "status": "enabled",
        "updatedAt": "2024-07-09T02:30:53+00:00",
        "updatedBy": "1cc381f7-1234-1234-ac7b-ae3cd6d1abcd"
      }
    }
  ],
  "links": {
    "next": "/api/v1/collections?page%5Bnumber%5D=2&page%5Bsize%5D=3",
    "self": "/api/v1/collections?page%5Bnumber%5D=1&page%5Bsize%5D=3"
  },
  "meta": {
    "page": {
      "maxSize": 100,
      "total": 6
    }
  }
}

Retrieve collection by ID

get

With a GET request to the /collections/{id} endpoint, you can retrieve the information of a collection by providing its ID.

Important: The API scope required to use this endpoint is: Readme items.

Path parameters

idstring · uuidRequired

The unique identifier of the collection.

Responses

200

OK

application/json

401

Unauthorized - User is not authorized to perform the request.

application/json

404

Not found - Resource not found.

application/json

get

/collections/{id}

HTTPcURLJavaScriptPython

GET /api/v1/collections/{id} HTTP/1.1
Host: my-workspace.cerby.com
Accept: */*

{
  "data": {
    "attributes": {
      "createdAt": "2024-07-12T23:10:27+00:00",
      "createdBy": "989165cc-112c-4112-a877-e047ffe9abcd",
      "meta": {},
      "name": "Employee",
      "roles": [
        "collection_owner"
      ],
      "status": "enabled",
      "updatedAt": "2024-07-12T23:10:27+00:00",
      "updatedBy": "989165cc-112c-4112-a877-e047ffe9abcd"
    },
    "id": "989165cc-112c-4112-a877-e047ffe9abcd",
    "type": "collections"
  }
}