> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one TimePass

> Retrieve a single TimePass record by its Id.

Passes allow customers to check in to a coworking space. There are two kinds:

* **Day Pass** — valid for a single calendar day. Created with `MinutesIncluded` omitted (null). The customer can check in any number of times during that day.
* **Time Pass** — valid across multiple days up to a fixed amount of time. Created with \`\`MinutesIncluded` <minutes>` set. The customer can check in until the included minutes are exhausted.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
  The authenticated user must be a full unrestricted administrator or have the **`TimePass-Read`** role.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the TimePass record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasses/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasses/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  Business Id.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Business name.
</ResponseField>

<ResponseField name="Name" type="string">
  Time pass name.
</ResponseField>

<ResponseField name="InvoiceLineDisplayAs" type="string">
  Invoice line display text.
</ResponseField>

<ResponseField name="Price" type="number">
  Price.
</ResponseField>

<ResponseField name="MinutesIncluded" type="integer">
  Minutes included.
</ResponseField>

<ResponseField name="CountsTowardsPlanLimits" type="boolean">
  Counts towards plan limits.
</ResponseField>

<ResponseField name="UseAsPayAsYouGoForMembers" type="boolean">
  Use as pay-as-you-go for members.
</ResponseField>

<ResponseField name="UseAsPayAsYouGoForContacts" type="boolean">
  Use as pay-as-you-go for contacts.
</ResponseField>

<ResponseField name="UsePriority" type="integer">
  Use priority.
</ResponseField>

<ResponseField name="CurrencyId" type="integer">
  Currency Id.
</ResponseField>

<ResponseField name="CurrencyCode" type="string">
  Currency code.
</ResponseField>

<ResponseField name="TaxRateId" type="integer">
  Tax Rate Id.
</ResponseField>

<ResponseField name="ReducedTaxRateId" type="integer">
  Reduced Tax Rate Id.
</ResponseField>

<ResponseField name="ExemptTaxRateId" type="integer">
  Exempt Tax Rate Id.
</ResponseField>

<ResponseField name="FinancialAccountId" type="integer">
  Financial Account Id.
</ResponseField>

<ResponseField name="Businesses" type="integer[]">
  Businesses.
</ResponseField>

<ResponseField name="KisiGroupId" type="string">
  Kisi group ID.
</ResponseField>

<ResponseField name="DoorGuardGroupId" type="string">
  DoorGuard group ID.
</ResponseField>

<ResponseField name="AccessControlGroupId" type="string">
  Access Control Group Id.
</ResponseField>

<ResponseField name="AccessControlGroupIds" type="string">
  Access Control Group Ids.
</ResponseField>

<ResponseField name="AllowNetworkCheckIn" type="boolean">
  Allow network check-in.
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  Only available for contacts.
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  Only available for members.
</ResponseField>

<ResponseField name="Tariffs" type="integer[]">
  Tariffs.
</ResponseField>

<ResponseField name="Archived" type="boolean">
  Archived.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "InvoiceLineDisplayAs": null,
  "Price": 0,
  "MinutesIncluded": null,
  "CountsTowardsPlanLimits": false,
  "UseAsPayAsYouGoForMembers": false,
  "UseAsPayAsYouGoForContacts": false,
  "UsePriority": null,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxRateId": null,
  "ReducedTaxRateId": null,
  "ExemptTaxRateId": null,
  "FinancialAccountId": null,
  "Businesses": [],
  "KisiGroupId": null,
  "DoorGuardGroupId": null,
  "AccessControlGroupId": null,
  "AccessControlGroupIds": null,
  "AllowNetworkCheckIn": false,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Tariffs": [],
  "Archived": false,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "TimePass Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```
