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

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

An **AutomationTile** represents a physical NFC chip and QR code tile that triggers actions in a Nexudus-powered coworking space. Each tile is linked to a single action (e.g. check-in, booking, door unlock, HTTP request) that fires when a customer scans or taps the tile.

The `Action` field determines what happens when the tile is scanned. Some actions require additional data in `ActionParameters`:

| Action                                                 | ActionParameters format                                                        |
| ------------------------------------------------------ | ------------------------------------------------------------------------------ |
| CheckIn / CheckOut / EventCheckIn                      | Not required                                                                   |
| BookingCheckIn / ResourceCleaned / ShowNewBookingForm  | Resource ID                                                                    |
| BookResource                                           | Resource ID `\|` default booking length in minutes (default 60)                |
| BookDesk                                               | Desk (floor plan item) ID `\|` default booking length in minutes (default 480) |
| ExtendBookingBy                                        | Number of minutes to extend                                                    |
| RequestUrl                                             | Target URL for the HTTP POST request                                           |
| RedirectUrl                                            | URL to redirect the user to                                                    |
| UnlockAct365Door / UnlockDoorDeckDoor / UnlockKisiDoor | Door ID from the access-control provider                                       |
| SmartLock                                              | Smartalock locker bank ID                                                      |

Tiles can optionally be geo-fenced to restrict scanning to a physical area around the tile's installed location. Enable `EnableGeofence`, set `Latitude`/`Longitude`, and choose a `GeofencePrecission` level. `MaxDistanceMeters` overrides the precision preset with a custom radius.

Set `CheckCustomerIn` to also check the customer into the space when they scan the tile, regardless of the tile's primary action.

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

## Enums

<Accordion title="eAutomationTileAction — Action values">
  | Value | Name                  |
  | ----- | --------------------- |
  | 1     | None                  |
  | 2     | UnlockAct365Door      |
  | 3     | CheckIn               |
  | 4     | CheckOut              |
  | 5     | BookingCheckIn        |
  | 6     | EventCheckIn          |
  | 7     | ResourceCleaned       |
  | 8     | RequestUrl            |
  | 9     | RedirectUrl           |
  | 10    | UnlockDoorDeckDoor    |
  | 11    | UnlockKisiDoor        |
  | 12    | BookResource          |
  | 13    | BookDesk              |
  | 14    | ShowNewBookingForm    |
  | 15    | SmartLock             |
  | 16    | ExtendBookingBy       |
  | 17    | ShowAcsModal          |
  | 18    | UnlockPadWordDoor     |
  | 19    | UnlockOPaxtonNet2Door |
</Accordion>

<Accordion title="eAutomationTileGeofencePrecission — GeofencePrecission values">
  | Value | Name     |
  | ----- | -------- |
  | 1     | Low      |
  | 2     | Medium   |
  | 3     | High     |
  | 4     | VeryHigh |
</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="AutomationTile_Business" type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField query="AutomationTile_Name" type="string">
  Filter by tile name used to identify it in the admin panel.
</ParamField>

<ParamField query="AutomationTile_TileNumber" type="string">
  Filter by unique tile identifier (GUID) auto-assigned on creation. Used to generate the QR code and NFC URL.
</ParamField>

<ParamField query="AutomationTile_Action" type="integer">
  Filter by action triggered when the tile is scanned: None, CheckIn, CheckOut, BookingCheckIn, EventCheckIn, ExtendBookingBy, RequestUrl, RedirectUrl, ResourceCleaned, BookResource, BookDesk, ShowNewBookingForm, UnlockAct365Door, UnlockDoorDeckDoor, UnlockKisiDoor, SmartLock, etc..
</ParamField>

<ParamField query="AutomationTile_ActionParameters" type="string">
  Filter by parameters for the selected action. Format depends on the action type — e.g. a resource ID, a URL, or a resource ID|duration pair.
</ParamField>

<ParamField query="AutomationTile_EnableGeofence" type="boolean">
  Filter by whether to restrict the tile to a geographic area. When enabled, the tile only works if the user is within the configured radius of the tile's coordinates.
</ParamField>

<ParamField query="AutomationTile_CheckCustomerIn" type="boolean">
  Filter by whether to also check the customer into the space when they scan the tile, regardless of the primary action.
</ParamField>

<ParamField query="AutomationTile_Longitude" type="string">
  Filter by longitude of the tile's installed location. Used for geofencing.
</ParamField>

<ParamField query="AutomationTile_Latitude" type="string">
  Filter by latitude of the tile's installed location. Used for geofencing.
</ParamField>

<ParamField query="AutomationTile_GeofencePrecission" type="integer">
  Filter by geofence precision level: Low, Medium, High, or VeryHigh. Higher precision requires the user to be closer to the tile coordinates.
</ParamField>

<ParamField query="AutomationTile_MaxDistanceMeters" type="integer">
  Filter by custom maximum distance in meters from the tile's coordinates. Overrides the precision preset when set.
</ParamField>

<ParamField query="AutomationTile_SuccessMessage" type="string">
  Filter by custom message shown to the user when the tile action completes successfully.
</ParamField>

<ParamField query="AutomationTile_ErrorMessage" type="string">
  Filter by custom error message shown to the user when the tile action fails.
</ParamField>

### Range Filters

<ParamField query="from_AutomationTile_MaxDistanceMeters" type="integer">
  Filter by custom maximum distance in meters from the tile's coordinates. Overrides the precision preset when set greater than or equal to this value.
</ParamField>

<ParamField query="to_AutomationTile_MaxDistanceMeters" type="integer">
  Filter by custom maximum distance in meters from the tile's coordinates. Overrides the precision preset when set less than or equal to this value.
</ParamField>

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

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

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

<ParamField query="to_AutomationTile_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/sys/automationtiles?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/sys/automationtiles?' + 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/sys/automationtiles',
      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/sys/automationtiles?AutomationTile_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/sys/automationtiles?' + new URLSearchParams({
      AutomationTile_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/sys/automationtiles',
      params={
          'AutomationTile_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/sys/automationtiles?from_AutomationTile_UpdatedOn=2025-01-01T00:00&to_AutomationTile_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/sys/automationtiles?' + new URLSearchParams({
      from_AutomationTile_UpdatedOn: '2025-01-01T00:00',
      to_AutomationTile_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/sys/automationtiles',
      params={
          'from_AutomationTile_UpdatedOn': '2025-01-01T00:00',
          'to_AutomationTile_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="AutomationTile[]">
  The list of AutomationTile records matching the query. See the [Get one AutomationTile](/rest-api/sys/get-automationtiles-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 AutomationTile. The following fields are **not populated** in the `Records[]` response: `Action`, `GeofencePrecission`.

  To get all fields, fetch the full record using the [Get one AutomationTile](/rest-api/sys/get-automationtiles-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,
      "Name": "",
      "TileNumber": null,
      "ActionParameters": null,
      "EnableGeofence": false,
      "CheckCustomerIn": false,
      "Longitude": null,
      "Latitude": null,
      "MaxDistanceMeters": null,
      "SuccessMessage": null,
      "ErrorMessage": null,
      "Resources": [],
      "Tariffs": [],
      "TimePasses": [],
      "FloorPlanDesks": [],
      "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": "AutomationTile 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
}
```
