Accounts

In Cerby, accounts are digital records that contain user login information for a particular app or service provider. An account object contains information about the account label, the app to which the account belongs, the password, the dates when the account was created and last updated, and the user who created and last updated the account. Additionally, an account_secret object contains information about the account’s password.

The account and account_secret objects are created in Cerby when you perform any of the following actions:

• Add an account manually through the Cerby web app or mobile app.

• Autosave an account at login or signup through the Cerby browser extension

• Import items from your password manager.

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

Important: You can only retrieve accounts to which you have the Owner role. Your permissions are determined by your API key based on Cerby’s RBAC system.

Retrieve the list of all accounts

get

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

Important: The API scope required to use this endpoint is Read accounts.

Query parameters

page[number]integer · min: 1Optional

The page number to retrieve in a paginated list.

Default: 1

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

The number of items to display per page.

Default: 25

filter[application]string[]Optional

A comma-separated list of applications.

Responses

200

OK — The JSON array with the account objects requested on the specified page.

application/json

400

Bad request - The server could not interpret the request due to invalid syntax or missing parameters. Review your request and correct it.

application/json

401

Unauthorized - User is not authorized to perform the request.

application/json

get

/accounts

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": "123456a7-1234-419f-123a-ae3cd6d12350",
      "type": "account",
      "attributes": {
        "application": "unmanaged",
        "createdAt": "2024-07-09T02:30:46+00:00",
        "createdBy": "123456a7-1234-419f-123a-ae3cd6d12341",
        "label": "Acme",
        "lastLoginDate": "2025-05-08T19:01:04.984000+00:00",
        "updatedAt": "2024-07-09T02:30:46+00:00",
        "workspace": "my-workspace"
      }
    },
    {
      "id": "123456a7-1234-419f-123a-ae3cd6d12360",
      "type": "account",
      "attributes": {
        "application": "twitter",
        "createdAt": "2024-02-01T21:49:17+00:00",
        "createdBy": "123456a7-1234-419f-123a-ae3cd6d12341",
        "label": "myAccount-twitter",
        "lastLoginDate": "2025-05-08T19:01:04.984000+00:00",
        "updatedAt": "2024-03-25T15:13:09+00:00",
        "workspace": "my-workspace"
      }
    },
    {
      "id": "123456a7-1234-419f-123a-ae3cd6d12345",
      "type": "account",
      "attributes": {
        "application": "mailchimp",
        "createdAt": "2024-05-23T20:24:35+00:00",
        "createdBy": "123456a7-1234-419f-123a-ae3cd6d12341",
        "label": "Mailchimp",
        "lastLoginDate": "2025-05-08T19:01:04.984000+00:00",
        "updatedAt": "2024-07-23T15:46:51+00:00",
        "workspace": "my-workspace"
      }
    }
  ],
  "links": {
    "next": "/api/v1/accounts?page%5Bnumber%5D=2&page%5Bsize%5D=3",
    "previous": null,
    "self": "/api/v1/accounts?page%5Bnumber%5D=1&page%5Bsize%5D=3"
  },
  "meta": {
    "page": {
      "maxSize": 100,
      "total": 18
    }
  }
}

Retrieve an account by ID

get

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

Important: The API scope required to use this endpoint is Read accounts.

Path parameters

idstringRequired

The unique identifier of the account.

Responses

200

OK — The requested account JSON object.

application/json

401

Unauthorized - User is not authorized to perform the request.

application/json

404

Not found - Resource not found.

application/json

get

/accounts/{id}

HTTPcURLJavaScriptPython

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

{
  "data": {
    "id": "989165cc-112c-1234-a877-e047ffe9abcd",
    "type": "account",
    "attributes": {
      "application": "discord_tenant",
      "createdAt": "2024-08-29T19:15:46.475000+00:00",
      "createdBy": "10b258e4-8454-1234-91a3-cacd42f0abcd",
      "label": "Discord",
      "lastLoginDate": "2025-05-08T19:01:04.984000+00:00",
      "updatedAt": "2024-08-29T19:33:05.028000+00:00",
      "workspace": "cerby"
    }
  }
}

Retrieve an account’s password

get

With a GET request to the /accounts/{id}/secrets endpoint, you can retrieve the password of an account by providing the account ID.

Important:

• The API scope required to use this endpoint is Read accounts.

• This endpoint retrieves the password for accounts stored in an AWS KMS vault only.

Path parameters

idstringRequired

The unique identifier of the account.

Query parameters

filter[secretType]stringRequired

The type of secret you want to retrieve from the account. The secret type value is always password.

page[number]integer · min: 1Optional

The page number to retrieve in a paginated list.

Default: 1

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

The number of items to display per page.

Default: 20

Responses

200

OK — The requested account secret JSON object.

application/json

400

Bad request - The server could not interpret the request due to invalid syntax or missing parameters. Review your request and correct it.

application/json

401

Unauthorized - User is not authorized to perform the request.

application/json

404

Not found - Resource not found.

application/json

get

/accounts/{id}/secrets

HTTPcURLJavaScriptPython

GET /api/v1/accounts/{id}/secrets?filter[secretType]=text HTTP/1.1
Host: my-workspace.cerby.com
Accept: */*

{
  "data": {
    "id": "583965f7-a0cb-43cb-bb28-918527cfae0c",
    "type": "password",
    "attributes": {
      "body": {
        "type": "plaintext",
        "value": "This-is-the-password"
      },
      "createdAt": "2025-03-06T19:13:53.971000+00:00",
      "secretType": "password",
      "updatedAt": "2025-03-06T19:13:53.971000+00:00",
      "vaultId": "76439949-53fc-429b-bb67-142ddc14b1d3"
    }
  },
  "links": {
    "next": null,
    "previous": "/api/v1/accounts/df8b23fc-7b67-4b28-b768-f9cf6456de90/secrets?page%5Bnumber%5D=1&page%5Bsize%5D=4",
    "self": "/api/v1/accounts/df8b23fc-7b67-4b28-b768-f9cf6456de90/secrets?page%5Bnumber%5D=2&page%5Bsize%5D=4"
  },
  "meta": {
    "page": {
      "maxSize": 100,
      "total": 1
    }
  }
}