FD
V1 V2

V1 · Account

Enterprises

List the enterprises (teams) the authenticated user belongs to.

An enterprise is FinDesk's tenant — internally modelled by App\Models\Team. Every other V1 resource is scoped to one enterprise via the EnterpriseID request header. Use the endpoints below to discover which enterprises the authenticated user can act on.

Attributes

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

Attribute Type Description
ID string (UUID) Enterprise UUID — the value to send in EnterpriseID.
Name string Enterprise display name.
IsActive boolean True when the active column equals 1.
created_at string (ISO 8601) Record creation timestamp (lowercase key — V1 inconsistency).
updated_at string (ISO 8601) Record updated timestamp (lowercase key — V1 inconsistency).

List enterprises

GET /api/v1/enterprises

Returns all enterprises the authenticated user belongs to (via auth()->user()->allTeams()). The response is a TeamsResource collection. Unlike the other V1 resources this endpoint is not paginated and does not require the EnterpriseID header — it is the discovery endpoint that tells you which UUIDs are valid.

Request headers

Header Required Description
Authorization Yes Bearer {token}.
Accept Yes application/json.

Responses

  • 200 — TeamsResource collection envelope ({ "data": [ ... ] }).

Retrieve an enterprise

GET /api/v1/enterprises/{team:uuid}

The {team} path parameter is the enterprise UUID. Route-model binding resolves on the uuid column.

Responses

  • 200 — single TeamResource envelope.
  • 403 Forbidden — caller does not belong to the enterprise.