<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
        SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
       title="List subusers visible to the authenticated user" id="listSubusers">

    <!-- AUTO-GENERATED, DO NOT EDIT -->
    <p>This endpoint documentation is generated directly from <code>openapi.yaml</code>.</p>
    <chapter title="Endpoint" id="endpoint">
        <code-block lang="http">GET /subusers</code-block>
    </chapter>
    <chapter title="Operation" id="operation">
        <p>Operation ID: <code>listSubusers</code></p>
        <p>Returns a paginated list of subusers (drivers) that have enabled grants tied to the
authenticated user&#x27;s customer number. Only subusers with at least one enabled, non-deleted
grant for the caller&#x27;s customer are returned.
</p>
    </chapter>
    <chapter title="Authentication" id="authentication">
        <p>Security requirements:</p>
        <table>
            <tr><td>Scheme</td><td>Scopes</td></tr>
            <tr><td>BearerAuth</td><td>-</td></tr>
        </table>
    </chapter>
    <chapter title="Parameters" id="parameters">
        <table>
            <tr><td>Name</td><td>In</td><td>Required</td><td>Type</td><td>Description</td></tr>
            <tr><td>page</td><td>query</td><td>no</td><td>integer</td><td></td></tr>
            <tr><td>limit</td><td>query</td><td>no</td><td>integer</td><td></td></tr>
            <tr><td>search</td><td>query</td><td>no</td><td>string</td><td></td></tr>
            <tr><td>include_non_enabled</td><td>query</td><td>no</td><td>boolean</td><td>Include subusers that only have non-enabled grants (default false)</td></tr>
        </table>
    </chapter>
    <chapter title="Responses" id="responses">
        <table>
            <tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
            <tr><td>200</td><td>List of visible subusers</td><td>application/json</td></tr>
            <tr><td>401</td><td></td><td></td></tr>
            <tr><td>500</td><td></td><td></td></tr>
        </table>
        <p>Schema for response <code>200</code> (<code>application/json</code>):</p>
        <code-block lang="json">
{
  &quot;items&quot;: {
    &quot;properties&quot;: {
      &quot;created_at&quot;: {
        &quot;format&quot;: &quot;date-time&quot;,
        &quot;nullable&quot;: true,
        &quot;type&quot;: &quot;string&quot;
      },
      &quot;email&quot;: {
        &quot;format&quot;: &quot;email&quot;,
        &quot;nullable&quot;: true,
        &quot;type&quot;: &quot;string&quot;
      },
      &quot;id&quot;: {
        &quot;type&quot;: &quot;integer&quot;
      },
      &quot;name&quot;: {
        &quot;nullable&quot;: true,
        &quot;type&quot;: &quot;string&quot;
      },
      &quot;permissions&quot;: {
        &quot;description&quot;: &quot;Aggregated permission keys granted for the caller&#x27;s customer&quot;,
        &quot;items&quot;: {
          &quot;type&quot;: &quot;string&quot;
        },
        &quot;type&quot;: &quot;array&quot;
      },
      &quot;phone&quot;: {
        &quot;nullable&quot;: true,
        &quot;type&quot;: &quot;integer&quot;
      },
      &quot;phone_country_code&quot;: {
        &quot;nullable&quot;: true,
        &quot;type&quot;: &quot;integer&quot;
      },
      &quot;suspended_at&quot;: {
        &quot;format&quot;: &quot;date-time&quot;,
        &quot;nullable&quot;: true,
        &quot;type&quot;: &quot;string&quot;
      },
      &quot;two_factor_enabled&quot;: {
        &quot;description&quot;: &quot;Indicates if 2FA is enabled for this account&quot;,
        &quot;type&quot;: &quot;boolean&quot;
      },
      &quot;updated_at&quot;: {
        &quot;format&quot;: &quot;date-time&quot;,
        &quot;nullable&quot;: true,
        &quot;type&quot;: &quot;string&quot;
      },
      &quot;username&quot;: {
        &quot;nullable&quot;: true,
        &quot;type&quot;: &quot;string&quot;
      }
    },
    &quot;type&quot;: &quot;object&quot;
  },
  &quot;type&quot;: &quot;array&quot;
}
        </code-block>
    </chapter>
</topic>
