APG PayAPG Paydocs

Parties

Get organisation

GET/organisations/{organisationId}
Request
GEThttps://api.tst.au.apgpay.dev/organisations/{organisationId}
curl -X GET https://api.tst.au.apgpay.dev/organisations/{organisationId} \
  -H "Authorization: Bearer $API_KEY"

Return one organisation in the caller's scope.

Permissions

Required permission
organisations:query

Requires the `query` action on `organisations` for the supplied runtime context

Path parameters

organisationIdstring
required

Responses

The response is a tagged shape: type is always "OrgViewAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "OrgViewAttributes"
organisationIdOrgIdrequired

Identifier of an organisation: a business's legal record, shared by every merchant, customer and owner that is that business.

Example org_9f2Kd8QpLzXw

registeredNamestring

Its name on the business register. Absent where none was ever stated.

Example Ada Lovelace

businessTypeMchtBusinessType
CompanyIndividualSoleTraderPartnershipTrustUnknown
companyTypestring

Private or Public, where the business is a company and it was stated.

Its registration with the business register and the tax office. Absent where none was stated, or what was stated could not be read.

countrystringrequired

ISO 3166-1 alpha-2. The country it is registered in: its tax identity's, where it has one.

Example AU

The registered office, as the business register records it. It is not the contact address.

How a business, or one person's ownership of it, is reached. Every field is optional.

Who owns it: persons, each with the contact given for that ownership, and other organisations.

The documents a trust or a partnership is evidenced by.

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "type": "OrgViewAttributes",
  "organisationId": "org_9f2Kd8QpLzXw",
  "registeredName": "Ada Lovelace",
  "businessType": "Company",
  "companyType": "string",
  "taxIdentity": {
    "type": "OrgTaxIdentityAttributes",
    "businessRegistrationNumber": "string",
    "companyRegistrationNumber": "string",
    "taxRegistrationNumber": "string"
  },
  "country": "AU",
  "registeredAddress": {
    "type": "MchtAddressAttributes",
    "unitNumber": "string",
    "streetNumber": "string",
    "streetName": "Ada Lovelace",
    "streetType": "string",
    "suburb": "string",
    "city": "string",
    "state": "string",
    "postalCode": "3000",
    "country": "AU"
  },
  "contactDetails": {
    "type": "OrgContactDetailsAttributes",
    "emailAddress": "ada@example.com",
    "phoneNumber": "+61400000000",
    "address": {
      "type": "MchtAddressAttributes",
      "unitNumber": "string",
      "streetNumber": "string",
      "streetName": "Ada Lovelace",
      "streetType": "string",
      "suburb": "string",
      "city": "string",
      "state": "string",
      "postalCode": "3000",
      "country": "AU"
    }
  },
  "owners": [
    {
      "type": "OrgOwnerOrganisation",
      "organisationId": "org_9f2Kd8QpLzXw"
    }
  ],
  "documents": [
    {
      "type": "OrgDocumentAttributes",
      "kind": "TrustDeed",
      "fileId": "lfile_9f2Kd8QpLzXw"
    }
  ],
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses