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

> Retrieve a single Checkin record by its Id.

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

## Path Parameters

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

## Code Examples

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

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

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

## Response

### 200

<ResponseField name="CoworkerId" type="integer">
  Coworker Id.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Full name of the checked-in customer.
</ResponseField>

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

<ResponseField name="BusinessName" type="string">
  Name of the location where the check-in takes place.
</ResponseField>

<ResponseField name="Source" type="integer">
  How the check-in was created (e.g. Manual, DoorAccess, NetworkActivity, NexIO Tile, or Sensor). See `eCheckinSource` enum values: `0` = None, `1` = Manual, `2` = DoorAccess, `3` = NetworkActivity, `4` = Tile, `5` = Sensor.
</ResponseField>

<ResponseField name="FromTime" type="string">
  Date and time the customer checked in.
</ResponseField>

<ResponseField name="ToTime" type="string">
  Date and time the customer checked out. Null while the check-in is still open.
</ResponseField>

<ResponseField name="CountsTowardsPlanLimits" type="boolean">
  Counts Towards Plan Limits.
</ResponseField>

<ResponseField name="CoworkerTimePassGuid" type="string">
  Coworker Time Pass Guid.
</ResponseField>

<ResponseField name="AutoCheckout" type="boolean">
  Auto Checkout.
</ResponseField>

<ResponseField name="LastActivity" type="string">
  Last Activity.
</ResponseField>

<ResponseField name="MacAddresses" type="string">
  MAC addresses of devices detected during a network-activity check-in.
</ResponseField>

<ResponseField name="TeamsAtTheTimeOfCheckin" type="string">
  Teams the customer belonged to when the check-in was recorded.
</ResponseField>

<ResponseField name="TariffAtTheTimeOfCheckin" type="string">
  Product (tariff) assigned to the customer when the check-in was recorded.
</ResponseField>

<ResponseField name="ValidateCheckinJobId" type="string">
  Validate Checkin Job Id.
</ResponseField>

<ResponseField name="FromTimeLocal" type="string">
  From Time Local.
</ResponseField>

<ResponseField name="ToTimeLocal" type="string">
  To Time Local.
</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": 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
}
```
