APG PayAPG Paydocs

Enterprises

Get enterprise

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

Return one enterprise.

Permissions

Required permission
enterprises:query

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

Path parameters

enterpriseIdstring
required

Responses

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

Discriminated by type
type = "EntViewAttributes"
enterpriseIdEntIdrequired

Identifier of an enterprise.

Example ent_9f2Kd8QpLzXw

slugstringrequired

URL-safe identifier. Unique across the platform.

businessNamestringrequired

Registered name of the business holding the contract.

Example Ada Lovelace

statusEntStatusrequired
EnabledDisabledUnknown
websitestringrequired
companyEmailstringrequired

Where the platform writes when it needs a person.

Example ada@example.com

companyPhonestringrequired

E.164 format, e.g. +61400000000.

Example +61400000000

encryptionKeyNamesarray of string

Names of the public keys the platform encrypts card data to for this enterprise. The keys themselves are never returned only that they are configured, and under what name.

Example Ada Lovelace

The registration the enterprise holds the contract under, once it has been given.

How this enterprise's sites and the dashboards beneath it look. Absent where it has set none.

The hosts this enterprise serves, one site each. Empty where it serves none.

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "EntViewAttributes",
  "enterpriseId": "ent_9f2Kd8QpLzXw",
  "slug": "string",
  "businessName": "Ada Lovelace",
  "status": "Enabled",
  "website": "string",
  "companyEmail": "ada@example.com",
  "companyPhone": "+61400000000",
  "encryptionKeyNames": [
    "Ada Lovelace"
  ],
  "registration": {
    "type": "EntRegistrationAttributes",
    "country": "AU",
    "businessRegistrationNumber": "string",
    "taxRegistrationNumber": "string",
    "registeredAddress": {
      "type": "MchtAddressAttributes",
      "unitNumber": "string",
      "streetNumber": "string",
      "streetName": "Ada Lovelace",
      "streetType": "string",
      "suburb": "string",
      "city": "string",
      "state": "string",
      "postalCode": "3000",
      "country": "AU"
    }
  },
  "branding": {
    "type": "EntBrandingAttributes",
    "displayName": "Ada Lovelace",
    "companyName": "Ada Lovelace",
    "supportEmail": "ada@example.com",
    "website": "string",
    "logoUri": "https://example.com/callback",
    "logoDarkUri": "https://example.com/callback",
    "iconUri": "https://example.com/callback",
    "logoAltText": "string",
    "primaryColor": "string",
    "primaryColorDark": "string"
  },
  "sites": [
    {
      "type": "EntSiteAttributes",
      "domain": "string",
      "app": {
        "type": "EntSiteAppDashboard"
      }
    }
  ],
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses