FD
V1 V2

V1 · Core resources

Organisations

Read organisations (legal entities) and their contact details for an enterprise.

An organisation represents a legal entity (Pty Ltd, trust, sole trader, etc.) inside an enterprise. As with People, V1 is effectively read-only: the store, update, and destroy routes exist but OrganisationController short-circuits each with 403 Forbidden.

Attributes

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

Attribute Type Description
ID string (UUID) Stable public identifier.
EnterpriseID string (UUID) UUID of the owning enterprise.
LegalName string Legal name (maps to the name column).
LegalStructure string | null Organisation-type label (OrganisationType->name).
ShortName string | null Short / abbreviated name (shortname column).
TrustName string | null Trust name (where applicable).
Acn string | null Australian Company Number.
Abn string | null Australian Business Number.
EntityType string | null ABN entity-type label (AbnType->name).
AbnRegistration string | null (date) ABN registration date (abn_date column).
AbnStatus string | null ABN status label (AbnStatus->name).
GstRegistered boolean True when gst_registered == 1.
GstDate string | null (date) GST registration date.
BusinessName / BusinessName2 / BusinessName3 string | null Up to three trading names.
FormerName / FormerName2 / FormerName3 string | null Up to three former names.
Description string | null Free-text description.
EstablishedDate string | null (date) Date the organisation was established.
EmployeesCount integer | null Employee count.
Industry string | null Industry label (industry->name).
Website string | null Website URL.
CreatedAt string (ISO 8601) Record creation timestamp.
UpdatedAt string (ISO 8601) Record updated timestamp.
PhoneNumbers object NumbersResource collection — same shape as on People.
Emails object EmailsResource collection — same shape as on People.
Addresses object AddressesResource collection — same shape as on People.

The nested resource shapes are documented on the People page.

List organisations

GET /api/v1/organisations

Returns a paginated list of organisations belonging to the enterprise identified by EnterpriseID. Page size is fixed at 100.

Responses

  • 200 — paginated OrganisationsResource collection.
  • 403 Forbidden — caller is not a member of the enterprise.

Retrieve an organisation

GET /api/v1/organisations/{organisation:uuid}

Responses

  • 200 — single OrganisationResource envelope.
  • 403 Forbidden — caller is not a member of the enterprise or the organisation's team_id does not match.

Create an organisation

POST /api/v1/organisations

OrganisationController::store() short-circuits and always returns 403 Forbidden. Write access has not been enabled in V1.

Update an organisation

PUT /api/v1/organisations/{organisation:uuid}

OrganisationController::update() short-circuits and always returns 403 Forbidden.

Delete an organisation

DELETE /api/v1/organisations/{organisation:uuid}

OrganisationController::destroy() short-circuits and always returns 403 Forbidden.