Client Account Users

The client account users API lets you manage who has access to a client account and what role they have. Each user in a client account is assigned a role that determines their permissions.

Only users with the Accountant (AA) or Client Account Owner (CA) role can manage other users. Regular users (US) can view the user list but cannot make changes.

Endpoints

List Users

GET /api/v2/client-accounts/{client_account_id}/users

Returns all active users in the client account with their roles, newest first. This endpoint is not paginated — it returns a plain JSON array and ignores page and per_page.

Query Parameters

Response

[
  {
    "id": 1,
    "created_at": "2024-01-15T08:30:00Z",
    "created_by_id": 7,
    "client_account_id": 42,
    "user_id": 7,
    "role_id": 3,
    "is_active": true
  }
]

Response with Relations

When ?with=user,role is included:

[
  {
    "id": 1,
    "created_at": "2024-01-15T08:30:00Z",
    "created_by_id": 7,
    "client_account_id": 42,
    "user_id": 7,
    "role_id": 3,
    "is_active": true,
    "user": {
      "id": 7,
      "created_at": "2024-01-10T12:00:00Z",
      "first_name": "Ola",
      "last_name": "Nordmann",
      "profile_image_url": "https://cdn.snapbooks.no/profile-images/abc123.jpg",
      "last_login": "2026-04-08T14:22:00Z"
    },
    "role": {
      "id": 3,
      "name": "CA"
    }
  }
]

Error Responses

Update User Role

PATCH /api/v2/client-accounts/{client_account_id}/users/{user_id}

Changes a user’s role within the client account. Only Accountants (AA) and Client Account Owners (CA) can update roles. You cannot change your own role.

Path Parameters

Request Body

Example Request

{
  "role_id": 5
}

Response

Returns the updated client account user object (same shape as list response items).

Error Responses

Remove User

DELETE /api/v2/client-accounts/{client_account_id}/users/{user_id}

Removes a user from the client account. This is a soft delete — the user’s is_active flag is set to false rather than deleting the record. Only Accountants (AA) and Client Account Owners (CA) can remove users.

Path Parameters

Response

Returns the updated client account user object with is_active set to false.

{
  "id": 1,
  "created_at": "2024-01-15T08:30:00Z",
  "created_by_id": 7,
  "client_account_id": 42,
  "user_id": 12,
  "role_id": 5,
  "is_active": false
}

Error Responses

Roles

Users in a client account are assigned one of the following roles:

Only users with the AA or CA role can update other users’ roles or remove users. The system prevents removing the last Client Account Owner to ensure every account retains at least one owner.

Attributes

Client Account User

Relations

Error Codes

Errors use the standard error envelope. Branch on code, not on message. In addition to the common codes, these endpoints return:

Example Error Response

{
    "error": {
        "code": "client_account.cannot_remove_last_owner",
        "message": "Cannot remove the last Client Account Owner from the account.",
        "request_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
    }
}

Related Resources

• Users — user profile management
• Client Accounts — the accounts users belong to
• Invitations — invite new users to join a client account