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

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

A **Checkin** records when a customer accessed a location. To check in, a customer must hold a valid pass (`TimePass` entity) that covers the location and the time of the check-in.

If the customer does not have a valid pass but the location or network has one or more **Pay As You Go** passes configured, a pass is automatically assigned and charged to the customer at check-in time.

Check-ins can be created manually, or opened and closed automatically by **NexIO** (the front-desk Nexudus tablet app), door-access systems, or IT-network integrations. The `Source` field indicates how the check-in was created.

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

## Enums

<Accordion title="eCheckinSource — Source values">
  | Value | Name            |
  | ----- | --------------- |
  | 0     | None            |
  | 1     | Manual          |
  | 2     | DoorAccess      |
  | 3     | NetworkActivity |
  | 4     | Tile            |
  | 5     | Sensor          |
</Accordion>

## 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="Checkin_Coworker" type="integer">
  Filter by Coworker Id.
</ParamField>

<ParamField query="Checkin_Coworker_FullName" type="string">
  Filter by full name of the checked-in customer.
</ParamField>

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

<ParamField query="Checkin_Business_Name" type="string">
  Filter by name of the location where the check-in takes place.
</ParamField>

<ParamField query="Checkin_Source" type="integer">
  Filter by how the check-in was created (e.g. Manual, DoorAccess, NetworkActivity, NexIO Tile, or Sensor).
</ParamField>

<ParamField query="Checkin_FromTime" type="string">
  Filter by date and time the customer checked in.
</ParamField>

<ParamField query="Checkin_ToTime" type="string">
  Filter by date and time the customer checked out. Null while the check-in is still open.
</ParamField>

<ParamField query="Checkin_CountsTowardsPlanLimits" type="boolean">
  Filter by Counts Towards Plan Limits.
</ParamField>

<ParamField query="Checkin_CoworkerTimePassGuid" type="string">
  Filter by Coworker Time Pass Guid.
</ParamField>

<ParamField query="Checkin_AutoCheckout" type="boolean">
  Filter by Auto Checkout.
</ParamField>

<ParamField query="Checkin_LastActivity" type="string">
  Filter by Last Activity.
</ParamField>

<ParamField query="Checkin_MacAddresses" type="string">
  Filter by mAC addresses of devices detected during a network-activity check-in.
</ParamField>

<ParamField query="Checkin_TeamsAtTheTimeOfCheckin" type="string">
  Filter by teams the customer belonged to when the check-in was recorded.
</ParamField>

<ParamField query="Checkin_TariffAtTheTimeOfCheckin" type="string">
  Filter by product (tariff) assigned to the customer when the check-in was recorded.
</ParamField>

<ParamField query="Checkin_ValidateCheckinJobId" type="string">
  Filter by Validate Checkin Job Id.
</ParamField>

<ParamField query="Checkin_FromTimeLocal" type="string">
  Filter by From Time Local.
</ParamField>

<ParamField query="Checkin_ToTimeLocal" type="string">
  Filter by To Time Local.
</ParamField>

### Range Filters

<ParamField query="from_Checkin_FromTime" type="string">
  Filter by date and time the customer checked in greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Checkin_FromTime" type="string">
  Filter by date and time the customer checked in less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Checkin_ToTime" type="string">
  Filter by date and time the customer checked out. Null while the check-in is still open greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Checkin_ToTime" type="string">
  Filter by date and time the customer checked out. Null while the check-in is still open less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Checkin_LastActivity" type="string">
  Filter by last activity greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Checkin_LastActivity" type="string">
  Filter by last activity less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Checkin_FromTimeLocal" type="string">
  Filter by from time local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Checkin_FromTimeLocal" type="string">
  Filter by from time local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Checkin_ToTimeLocal" type="string">
  Filter by to time local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Checkin_ToTimeLocal" type="string">
  Filter by to time local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

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

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

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

<ParamField query="to_Checkin_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/spaces/checkins?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/checkins?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'CreatedOn',
      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/spaces/checkins',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'CreatedOn',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

### Filtering by CreatedOn

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/spaces/checkins?' + new URLSearchParams({
      Checkin_CreatedOn: 'example-value',
      orderBy: 'CreatedOn',
      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/spaces/checkins',
      params={
          'Checkin_CreatedOn': 'example-value',
          'orderBy': 'CreatedOn',
          '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/spaces/checkins?from_Checkin_UpdatedOn=2025-01-01T00:00&to_Checkin_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/spaces/checkins?' + new URLSearchParams({
      from_Checkin_UpdatedOn: '2025-01-01T00:00',
      to_Checkin_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/spaces/checkins',
      params={
          'from_Checkin_UpdatedOn': '2025-01-01T00:00',
          'to_Checkin_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="Checkin[]">
  The list of Checkin records matching the query. See the [Get one Checkin](/rest-api/spaces/get-checkins-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<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": [
    {
      "CoworkerId": null,
      "CoworkerFullName": null,
      "BusinessId": 0,
      "BusinessName": null,
      "Source": 0,
      "FromTime": "2025-01-15T10:30:00Z",
      "ToTime": null,
      "CountsTowardsPlanLimits": false,
      "CoworkerTimePassGuid": null,
      "AutoCheckout": false,
      "LastActivity": null,
      "MacAddresses": null,
      "TeamsAtTheTimeOfCheckin": null,
      "TariffAtTheTimeOfCheckin": null,
      "ValidateCheckinJobId": null,
      "FromTimeLocal": null,
      "ToTimeLocal": 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": "Checkin Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}
```