Get a subuser by ID (visible by grant)

This endpoint documentation is generated directly from openapi.yaml.

Endpoint

GET /subusers/{id}

Operation

Operation ID: getSubuser

Returns the subuser if the authenticated user has at least one enabled, non-deleted grant for their customer number to this subuser. Otherwise returns 404.

Authentication

Security requirements:

Scheme	Scopes
BearerAuth	-

Parameters

Name	In	Required	Type	Description
id	path	yes	integer

Responses

Status	Description	Content Types
200	Subuser details	application/json
401
404
500

Schema for response 200 (application/json):

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "email": {
      "format": "email",
      "nullable": true,
      "type": "string"
    },
    "id": {
      "type": "integer"
    },
    "name": {
      "nullable": true,
      "type": "string"
    },
    "permissions": {
      "description": "Aggregated permission keys granted for the caller's customer",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "phone": {
      "nullable": true,
      "type": "integer"
    },
    "phone_country_code": {
      "nullable": true,
      "type": "integer"
    },
    "suspended_at": {
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "username": {
      "nullable": true,
      "type": "string"
    }
  },
  "type": "object"
}
        

17 March 2026