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

# Search TimePasses

> Search and list TimePass records with filtering, sorting, and pagination.

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-List`** role.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="TimePass_Business" type="integer">
  Filter by Business Id.
</ParamField>

<ParamField query="TimePass_Business_Name" type="string">
  Filter by business name.
</ParamField>

<ParamField query="TimePass_Name" type="string">
  Filter by time pass name.
</ParamField>

<ParamField query="TimePass_InvoiceLineDisplayAs" type="string">
  Filter by invoice line display text.
</ParamField>

<ParamField query="TimePass_Price" type="number">
  Filter by price.
</ParamField>

<ParamField query="TimePass_MinutesIncluded" type="integer">
  Filter by minutes included.
</ParamField>

<ParamField query="TimePass_CountsTowardsPlanLimits" type="boolean">
  Filter by counts towards plan limits.
</ParamField>

<ParamField query="TimePass_UseAsPayAsYouGoForMembers" type="boolean">
  Filter by use as pay-as-you-go for members.
</ParamField>

<ParamField query="TimePass_UseAsPayAsYouGoForContacts" type="boolean">
  Filter by use as pay-as-you-go for contacts.
</ParamField>

<ParamField query="TimePass_UsePriority" type="integer">
  Filter by use priority.
</ParamField>

<ParamField query="TimePass_Currency" type="integer">
  Filter by Currency Id.
</ParamField>

<ParamField query="TimePass_Currency_Code" type="string">
  Filter by currency code.
</ParamField>

<ParamField query="TimePass_TaxRate" type="integer">
  Filter by Tax Rate Id.
</ParamField>

<ParamField query="TimePass_ReducedTaxRate" type="integer">
  Filter by Reduced Tax Rate Id.
</ParamField>

<ParamField query="TimePass_ExemptTaxRate" type="integer">
  Filter by Exempt Tax Rate Id.
</ParamField>

<ParamField query="TimePass_FinancialAccount" type="integer">
  Filter by Financial Account Id.
</ParamField>

<ParamField query="TimePass_KisiGroupId" type="string">
  Filter by kisi group ID.
</ParamField>

<ParamField query="TimePass_DoorGuardGroupId" type="string">
  Filter by doorGuard group ID.
</ParamField>

<ParamField query="TimePass_AccessControlGroupId" type="string">
  Filter by Access Control Group Id.
</ParamField>

<ParamField query="TimePass_AccessControlGroupIds" type="string">
  Filter by Access Control Group Ids.
</ParamField>

<ParamField query="TimePass_AllowNetworkCheckIn" type="boolean">
  Filter by allow network check-in.
</ParamField>

<ParamField query="TimePass_OnlyForContacts" type="boolean">
  Filter by only available for contacts.
</ParamField>

<ParamField query="TimePass_OnlyForMembers" type="boolean">
  Filter by only available for members.
</ParamField>

<ParamField query="TimePass_Archived" type="boolean">
  Filter by archived.
</ParamField>

### Range Filters

<ParamField query="from_TimePass_Price" type="number">
  Filter by price greater than or equal to this value.
</ParamField>

<ParamField query="to_TimePass_Price" type="number">
  Filter by price less than or equal to this value.
</ParamField>

<ParamField query="from_TimePass_MinutesIncluded" type="integer">
  Filter by minutes included greater than or equal to this value.
</ParamField>

<ParamField query="to_TimePass_MinutesIncluded" type="integer">
  Filter by minutes included less than or equal to this value.
</ParamField>

<ParamField query="from_TimePass_UsePriority" type="integer">
  Filter by use priority greater than or equal to this value.
</ParamField>

<ParamField query="to_TimePass_UsePriority" type="integer">
  Filter by use priority less than or equal to this value.
</ParamField>

<ParamField query="from_TimePass_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_TimePass_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_TimePass_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_TimePass_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasses?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

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

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

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasses',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasses?TimePass_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses?' + new URLSearchParams({
      TimePass_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

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

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

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasses',
      params={
          'TimePass_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/timepasses?from_TimePass_UpdatedOn=2025-01-01T00:00&to_TimePass_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/timepasses?' + new URLSearchParams({
      from_TimePass_UpdatedOn: '2025-01-01T00:00',
      to_TimePass_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

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

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

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/timepasses',
      params={
          'from_TimePass_UpdatedOn': '2025-01-01T00:00',
          'to_TimePass_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

## Response

### 200

<ResponseField name="Records" type="TimePass[]">
  The list of TimePass records matching the query. See the [Get one TimePass](/rest-api/billing/get-timepasses-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each TimePass. The following fields are **not populated** in the `Records[]` response: `CountsTowardsPlanLimits`, `OnlyForContacts`, `OnlyForMembers`.

  To get all fields, fetch the full record using the [Get one TimePass](/rest-api/billing/get-timepasses-by-id) endpoint.

  **Important for updates:** When updating a record via `PUT`, always retrieve the full record with a `GET` request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a `PUT` request, as missing fields may be unintentionally cleared.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "InvoiceLineDisplayAs": null,
      "Price": 0,
      "MinutesIncluded": null,
      "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,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```