API: Favorite passwords/projects

API v6

Sections: List favorite passwords/projects | Set a password/project as favorite | Set a password/project as not favorite

List favorite passwords/my passwords/projects

These calls return the favorite passwords or projects of the user making the request.

GET /favorite_passwords.json = GET /passwords/favorite.json

GET /favorite_my_passwords.json = GET /my_passwords/favorite.json

GET /favorite_projects.json = GET /projects/favorite.json

The responses from these requests are paginated and /count.json, /page/num.json and X-Page-Size can be used. See the section on pagination for more information. Example: GET /favorite_passwords/page/2.json

If successful, the response code is 200 OK with the results of the call in the response body.

Example response body (favorite passwords):

[
  {
        "id": 68,
        "name": "Wordpress admin",
        "project": {
            "id": 18,
            "name": "www.fictionalgadgetsite.com"
        },
        "project_full_path": [
            {
                "id": 6,
                "name": "Internal",
                "archived": false
            },
            {
                "id": 5,
                "name": "Company projects",
                "archived": false
            },
            {
                "id": 18,
                "name": "www.fictionalgadgetsite.com",
                "archived": false
            }
        ],
        "notes_snippet": "Some notes for the wp admin credentials.",
        "tags": "wordpress",
        "access_info": "http:\/\/www.fictionalgadgetsite.com\/wp-admin",
        "username": "admin_sg",
        "email": "",
        "has_password": true,
        "strength": "good",
        "expiry_date": "2024-12-31",
        "expiry_status": 3,
        "archived": false,
        "project_archived": false,
        "favorite": true,
        "num_files": 2,
        "locked": false,
        "locking_type": 0,
        "external_sharing": false,
        "linked": false,
        "source_password_id": 0,
        "managed_by": {
            "id": 1
        },
        "created_by": {
            "id": 1
        },
        "created_on": "2024-12-16 14:36:08",
        "updated_by": {
            "id": 1
        },
        "updated_on": "2024-12-18 07:13:51"
    },
    {
        "id": 60,
        "name": "DNS server account",
        "project": {
            "id": 16,
            "name": "Company internet services"
        },
        "project_full_path": [
            {
                "id": 6,
                "name": "Internal",
                "archived": false
            },
            {
                "id": 16,
                "name": "Company internet services",
                "archived": false
            }
        ],
        "notes_snippet": "",
        "tags": "hosting",
        "access_info": "http:\/\/ourcompany.mydnsacct.com",
        "username": "",
        "email": "ourcemail@ourcdomain.com",
        "has_password": true,
        "strength": "good",
        "expiry_date": null,
        "expiry_status": 0,
        "archived": false,
        "project_archived": false,
        "favorite": true,
        "num_files": 0,
        "locked": false,
        "locking_type": 0,
        "external_sharing": false,
        "linked": false,
        "source_password_id": 0,
        "managed_by": {
            "id": 1
        },
        "created_by": {
            "id": 1
        },
        "created_on": "2024-12-16 14:36:08",
        "updated_by": {
            "id": 1
        },
        "updated_on": "2024-12-16 14:36:08"
    }
]

Metadata only lists

All favorite list requests can include the following header: X-Metadata-Only: true. When this header is used, the response will only include the metadata fields of the favorite elements. For example (favorite passwords):

[
    {
        "id": 68,
        "managed_by": {
            "id": 1
        },
        "created_by": {
            "id": 1
        },
        "created_on": "2024-12-16 14:36:08",
        "updated_by": {
            "id": 1
        },
        "updated_on": "2024-12-18 07:13:51"
    },
    {
        "id": 60,
        "managed_by": {
            "id": 1
        },
        "created_by": {
            "id": 1
        },
        "created_on": "2024-12-16 14:36:08",
        "updated_by": {
            "id": 1
        },
        "updated_on": "2024-12-16 14:36:08"
    }
]

Permissions lists

The favorite password and project list requests can include the following header: X-Permissions: true. When this header is used, the response will only include the fields that refer to the permissions assigned to users and groups for the password / project. These fields are: managed_by, users_permissions and groups_permissions, and also grant_all_permission for projects. All of these fields are the same fields as in the show a password/project request, but here only the ids are returned, for speed. The metadata fields are included for completeness. For example (favorite passwords):

[
    {
        "id": 68,
        "users_permissions": [
            {
                "user": {
                    "id": 2
                },
                "permission": {
                    "id": 10,
                    "label": "Read"
                }
            },
            {
                "user": {
                    "id": 4
                },
                "permission": {
                    "id": 30,
                    "label": "Manage"
                }
            },
            {
                "user": {
                    "id": 8
                },
                "permission": {
                    "id": 20,
                    "label": "Edit data"
                }
            }
        ],
        "groups_permissions": [
            {
                "group": {
                    "id": 3
                },
                "permission": {
                    "id": 0,
                    "label": "No access"
                }
            },
            {
                "group": {
                    "id": 4
                },
                "permission": {
                    "id": 30,
                    "label": "Manage"
                }
            }
        ],
        "managed_by": {
            "id": 1
        },
        "created_by": {
            "id": 1
        },
        "created_on": "2024-12-16 14:36:08",
        "updated_by": {
            "id": 1
        },
        "updated_on": "2024-12-18 07:13:51"
    },
    {
        "id": 60,
        "users_permissions": null,
        "groups_permissions": null,
        "managed_by": {
            "id": 1
        },
        "created_by": {
            "id": 1
        },
        "created_on": "2024-12-16 14:36:08",
        "updated_by": {
            "id": 1
        },
        "updated_on": "2024-12-16 14:36:08"
    }
]

Notes:

• Requests with the X-Permissions: true header are only available to Admin users.
• The X-Permissions: true header has priority over the X-Metadata-Only: true header.
• For locked passwords, users_permissions and groups_permissions are null.

Set a password/my password/project as favorite for the user making the request

POST /favorite_passwords/ID.json

POST /favorite_my_passwords/ID.json

POST /favorite_projects/ID.json

The request body is empty.

If successful, the response code is 204 No content and the response body is empty.

Set a password/my passwords/project as not favorite for the user making the request

DELETE /favorite_passwords/ID.json

DELETE /favorite_my_passwords/ID.json

DELETE /favorite_projects/ID.json

If successful, the response code is 204 No content and the response body is empty.