V1 · Account

Users

Read the users that belong to a given enterprise.

A user is a person who can sign in to FinDesk. The V1 user endpoints are scoped to an enterprise via EnterpriseID and are read-only.

Attributes
List users
- Request headers
- Responses
Retrieve a user
- Responses

Attributes

The shape returned by App\Http\Resources\V1\UserResource::toArray():

Attribute	Type	Description
`ID`	string (UUID)	Stable public identifier.
`Name`	string	User display name.
`Email`	string	User email address.
`IsActive`	boolean	True when the `active` column equals `1`.
`CreatedAt`	string (ISO 8601)	Record creation timestamp.
`UpdatedAt`	string (ISO 8601)	Record updated timestamp.

List users

GET /api/v1/users

Returns all users that belong to the enterprise identified by EnterpriseID (via $team->allUsers()). This endpoint is not paginated.

Request headers

Header	Required	Description
`Authorization`	Yes	`Bearer {token}`.
`Accept`	Yes	`application/json`.
`EnterpriseID`	Yes	Enterprise UUID.

Responses

200 — UsersResource collection envelope.
403 Forbidden — caller is not a member of the enterprise.

Retrieve a user

GET /api/v1/users/{user:uuid}

Responses

200 — single UserResource envelope.
403 Forbidden — caller is not a member of the enterprise identified by EnterpriseID. The V1 controller does not additionally check that the resolved user belongs to that team.

GET /api/v1/users

{
    "headers": {
        "Authorization": "Bearer {token}",
        "Accept": "application/json",
        "EnterpriseID": "{enterprise_uuid}"
    }
}

list_response

{
    "data": [
        {
            "ID": "0aa55b66-7c88-49d0-b1e2-f3a4b5c6d7e8",
            "Name": "Olivia Chen",
            "Email": "olivia@acmefinance.com.au",
            "IsActive": true,
            "CreatedAt": "2024-01-04T01:22:33.000000Z",
            "UpdatedAt": "2026-04-09T03:21:55.000000Z"
        },
        {
            "ID": "1bb66c77-8d99-4ae1-c2f3-04b5c6d7e8f9",
            "Name": "James Patel",
            "Email": "james@acmefinance.com.au",
            "IsActive": true,
            "CreatedAt": "2024-02-19T06:55:11.000000Z",
            "UpdatedAt": "2026-03-21T11:42:08.000000Z"
        }
    ]
}

GET /api/v1/users/{user_uuid}

{
    "headers": {
        "Authorization": "Bearer {token}",
        "Accept": "application/json",
        "EnterpriseID": "{enterprise_uuid}"
    }
}

show_response

{
    "data": {
        "ID": "0aa55b66-7c88-49d0-b1e2-f3a4b5c6d7e8",
        "Name": "Olivia Chen",
        "Email": "olivia@acmefinance.com.au",
        "IsActive": true,
        "CreatedAt": "2024-01-04T01:22:33.000000Z",
        "UpdatedAt": "2026-04-09T03:21:55.000000Z"
    }
}