---
title: "The authenticated organization"
canonical_url: "https://twominutebilling.com/help/developers/api-reference/organization/the-authenticated-organization"
---
# The authenticated organization

<api-operation method="GET" path="/v1/me">
<template v-slot:docs="">

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        id
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The organization's id (org_…).
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        name
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The organization's name.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        timezone
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      Display timezone for org-scoped screens; null means UTC. Never used for billing arithmetic — that is <code>
        business.timezone
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        icon_url
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      Square logo shown in the dashboard sidebar; null means none is set.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        live_access
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      Whether the organization can change its live businesses. Every organization starts <code>
        enabled
      </code>
      
      , including one on the free plan. Our staff can set it to <code>
        locked
      </code>
      
      : then writes to a live business answer 403 with code <code>
        live_access_required
      </code>
      
      , and test mode works in full. Cloud only: always <code>
        enabled
      </code>
      
       on a self-hosted installation. One of <code>
        locked
      </code>
      
      , <code>
        enabled
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        status
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <code>
        restricted
      </code>
      
       makes the organization read-only: every write answers 403 with code <code>
        account_restricted
      </code>
      
      . This occurs when its plan is unpaid, until the open invoice is paid. It also occurs when the organization bills more than its plan covers and our staff make it read-only, until it changes to a plan that covers its billing. Its own billing to its customers continues. Cloud only: always <code>
        active
      </code>
      
       on a self-hosted installation. One of <code>
        active
      </code>
      
      , <code>
        restricted
      </code>
      
      .
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      Success
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        401
      </code>
    </td>
    
    <td>
      Unauthenticated
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl "$TMBILLING_URL/v1/me" \
  -H "Authorization: Bearer $TMBILLING_API_KEY"
```

</template>

<template v-slot:response="">
<code-group>

```json [200 OK]
{
  "object": "organization",
  "id": "org_XXXXXXXXXXXX01",
  "name": "Brightwater Analytics",
  "timezone": "Asia/Kolkata",
  "icon_url": "https://example.com/webhooks/billing",
  "live_access": "locked",
  "status": "active"
}
```

```json [401 Unauthorized]
{
  "error": {
    "type": "authentication_error",
    "message": "Unauthenticated"
  }
}
```

</code-group>
</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.