APG PayAPG Paydocs

Identity

Get user

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

Return one user.

Permissions

Required permission
users:query

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

Path parameters

userIdstring
required

Responses

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

Discriminated by type
type = "UserViewAttributes"
userIdUserIdrequired

Identifier of a user.

Example user_9f2Kd8QpLzXw

displayNamestringrequired

Example Ada Lovelace

The identifiers this user can be recognised by.

statusUserStatusrequired
EnabledDisabledUnknown
createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "UserViewAttributes",
  "userId": "user_9f2Kd8QpLzXw",
  "displayName": "Ada Lovelace",
  "identifiedBy": [
    {
      "type": "UserIdEmail",
      "emailAddress": "ada@example.com"
    }
  ],
  "authorisedTo": [
    {
      "type": "UserPermissionAttributes",
      "domain": {
        "type": "UserDomainAnonymous",
        "restrictedTo": {
          "type": "UserDomainCustomer",
          "customerId": "cust_9f2Kd8QpLzXw"
        }
      },
      "roles": [
        "role_9f2Kd8QpLzXw"
      ]
    }
  ],
  "status": "Enabled",
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses