> ## 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 CoworkerTimePass

> Retrieve a single CoworkerTimePass record by its Id.

A **CoworkerTimePass** represents a time pass assigned to a customer. Time passes can be assigned directly, granted by a product purchase (`CoworkerProductUniqueId`), or included in a pricing plan (`TariffTimePassUniqueId`).

Each time pass tracks its usage status (`Used`, `UsedDate`), remaining and total uses, and whether the customer is currently checked in. Time passes may have an expiration date and can be free or priced.

Use `CreateMultiple` when creating to issue several time passes at once. The `IsFromTariff` and `IsPayAsYouGo` flags indicate the origin and billing model of the time pass.

## 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 **`CoworkerTimePass-Read`** role.
</Note>

## Path Parameters

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

## Code Examples

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkertimepasses/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/coworkertimepasses/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  The customer who owns this time pass.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  The business (location) this time pass belongs to.
</ResponseField>

<ResponseField name="TimePassId" type="integer">
  The time pass definition this is an instance of.
</ResponseField>

<ResponseField name="TimePassName" type="string">
  Name of the linked time pass.
</ResponseField>

<ResponseField name="TimePassCurrencyCode" type="string">
  Currency code of the linked time pass.
</ResponseField>

<ResponseField name="Notes" type="string">
  Optional notes for this time pass.
</ResponseField>

<ResponseField name="PurchaseOrder" type="string">
  Purchase order reference.
</ResponseField>

<ResponseField name="Used" type="boolean">
  Whether this time pass has been used.
</ResponseField>

<ResponseField name="CheckedIn" type="boolean">
  Whether the customer is currently checked in with this time pass.
</ResponseField>

<ResponseField name="UsedDate" type="string">
  Date when this time pass was used.
</ResponseField>

<ResponseField name="RemainingUses" type="integer">
  Number of remaining uses on this time pass.
</ResponseField>

<ResponseField name="TotalUses" type="integer">
  Total number of uses allowed on this time pass.
</ResponseField>

<ResponseField name="Free" type="boolean">
  Whether this time pass is free of charge.
</ResponseField>

<ResponseField name="Price" type="number">
  Custom price for this time pass.
</ResponseField>

<ResponseField name="CreateMultiple" type="integer">
  Number of time passes to create at once.
</ResponseField>

<ResponseField name="ExpireDate" type="string">
  Expiration date for this time pass.
</ResponseField>

<ResponseField name="Invoiced" type="boolean">
  Whether this time pass has been invoiced.
</ResponseField>

<ResponseField name="InvoiceDate" type="string">
  Date when this time pass was invoiced.
</ResponseField>

<ResponseField name="IsFromTariff" type="boolean">
  Whether this time pass was granted by a pricing plan (tariff).
</ResponseField>

<ResponseField name="IsPayAsYouGo" type="boolean">
  Whether this is a pay-as-you-go time pass.
</ResponseField>

<ResponseField name="TariffTimePassUniqueId" type="string">
  Unique identifier linking this time pass to a tariff time pass allocation.
</ResponseField>

<ResponseField name="CoworkerProductUniqueId" type="string">
  Unique identifier linking this time pass to a customer product purchase.
</ResponseField>

<ResponseField name="CoworkerContractUniqueId" type="string">
  Unique identifier linking this time pass to a customer contract.
</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}
{
  "CoworkerId": 0,
  "BusinessId": 0,
  "TimePassId": 0,
  "TimePassName": null,
  "TimePassCurrencyCode": null,
  "Notes": null,
  "PurchaseOrder": null,
  "Used": false,
  "CheckedIn": false,
  "UsedDate": null,
  "RemainingUses": null,
  "TotalUses": null,
  "Free": false,
  "Price": null,
  "CreateMultiple": 0,
  "ExpireDate": null,
  "Invoiced": false,
  "InvoiceDate": null,
  "IsFromTariff": false,
  "IsPayAsYouGo": false,
  "TariffTimePassUniqueId": null,
  "CoworkerProductUniqueId": null,
  "CoworkerContractUniqueId": null,
  "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": "CoworkerTimePass Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```