List subusers visible to the authenticated user

This endpoint documentation is generated directly from openapi.yaml.

Endpoint

GET /subusers

Operation

Operation ID: listSubusers

Returns a paginated list of subusers (drivers) that have enabled grants tied to the authenticated user's customer number. Only subusers with at least one enabled, non-deleted grant for the caller's customer are returned.

Authentication

Security requirements:

Scheme	Scopes
BearerAuth	-

Parameters

Name	In	Required	Type	Description
page	query	no	integer
limit	query	no	integer
search	query	no	string
include_non_enabled	query	no	boolean	Include subusers that only have non-enabled grants (default false)

Responses

Status	Description	Content Types
200	List of visible subusers	application/json
401
500

Schema for response 200 (application/json):

{
  "items": {
    "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"
      },
      "two_factor_enabled": {
        "description": "Indicates if 2FA is enabled for this account",
        "type": "boolean"
      },
      "updated_at": {
        "format": "date-time",
        "nullable": true,
        "type": "string"
      },
      "username": {
        "nullable": true,
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}
        

17 March 2026