V2 · Account

Users

Read the users that belong to a given enterprise.

A user is a person who can sign in to FinDesk. The V2 user endpoints are scoped to an enterprise via X-Enterprise-Id and are read-only.

Attributes

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

Attribute Type Description
id string (UUID) Stable public identifier.
name string User display name.
email string User email address.
is_active boolean True when the active column equals 1.
created_at string (ISO 8601) Record creation timestamp.
updated_at string (ISO 8601) Record updated timestamp.

List users

GET /api/v2/users

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

Request headers

Header Required Description
Authorization Yes Bearer {token}.
Accept Yes application/json.
X-Enterprise-Id Yes Enterprise UUID.

Responses

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

Retrieve a user

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

Responses

  • 200 — single UserResource envelope.
  • 403 Forbidden — caller is not a member of the enterprise, or the resolved user does not belong to that enterprise (checked via $team->hasUser($user)).

V2 differences — Read-only resource; App\Http\Middleware\NormalizeApiInput is a no-op here. See Auth for the canonical normaliser description.