### Get Signed In User Request

Source: https://developer.remotelock.com/api/docs

Example of a GET request to retrieve details of the currently signed-in user. No parameters are required.

```http
GET /user
```

--------------------------------

### Get Ready PIN Models Request

Source: https://developer.remotelock.com/api/docs

Example request to retrieve all available ready PIN models.

```http
GET /ready_pin_models
```

--------------------------------

### Get All ReadyPINs Response

Source: https://developer.remotelock.com/api/docs

Example response for retrieving all Kore ReadyPINs, including their details and pagination metadata. This endpoint is deprecated.

```json
{
  "data": [
    {
      "type": "kore_ready_pin",
      "attributes": {
        "uuid": "00000000-0000-0000-0000-000000000255",
        "name": "Deanne Blanda",
        "email": "echo.langosh@hudson.io",
        "starts_at": "2000-01-01T00:00:00Z",
        "ends_at": "2000-01-01T00:00:00Z",
        "status": "current",
        "source": null,
        "created_at": "2000-01-01T00:00:00Z",
        "updated_at": "2000-01-01T00:00:00Z",
        "pin": "NORMALIZED",
        "lock_id": "00000000-0000-0000-0000-000000000256"
      },
      "id": "00000000-0000-0000-0000-000000000255",
      "links": {
        "self": "http://api.remotelock.dev/kore_ready_pins/00000000-0000-0000-0000-000000000255",
        "lock": "http://api.remotelock.dev/devices/00000000-0000-0000-0000-000000000256"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 1,
    "total_pages": 1
  }
}
```

--------------------------------

### Get All Notification Subscriptions

Source: https://developer.remotelock.com/api/docs

This is an example of a GET request to retrieve all notification subscriptions. The response includes a list of subscriptions with their associated events, subscriber and publisher details, and metadata.

```bash
GET /notification_subscriptions
```

--------------------------------

### Access Guest Response Example

Source: https://developer.remotelock.com/api/docs

This is an example of a successful 200 OK response when retrieving access guest information.

```json
{
  "data": {
    "type": "access_guest",
    "attributes": {
      "name": "Melvin Legros",
      "email": "cyril@ziemann.info",
      "phone": null,
      "department": null,
      "deliver_as_qr_code": false,
      "status": "current",
      "source": null,
      "guest_source": null,
      "deliver_as_url_credential": false,
      "require_pin_verification": false,
      "schlage_engage_mobile_credentials_enabled": false,
      "korelock_wifi_credential_enabled": false,
      "ttlock_mobile_credential_enabled": false,
      "igloo_mobile_credentials_enabled": false,
      "august_mobile_credentials_enabled": false,
      "dormakaba_lyazon_mobile_credentials_enabled": false,
      "yonomi_mobile_credentials_enabled": false,
      "card_number_is_hex": false,
      "created_at": "2000-01-01T00:00:00Z",
      "updated_at": "2000-01-01T00:00:00Z",
      "pin": null,
      "card_number": null,
      "schlage_engage_smart_card_id": null,
      "schlage_engage_smart_card_badge": null,
      "url_credential": null,
      "starts_at": "2000-01-01T00:00:00Z",
      "ends_at": "2000-01-01T00:00:00Z",
      "ready_pins": [
        "9977423005"
      ],
      "ready_pin_model_id": "00000000-0000-0000-0000-000000000258"
    },
    "id": "00000000-0000-0000-0000-000000000257",
    "links": {
      "self": "http://api.remotelock.dev/access_persons/00000000-0000-0000-0000-000000000257",
      "ready_pin_model": "http://api.remotelock.dev/ready_pin_models/00000000-0000-0000-0000-000000000258"
    },
    "meta": {
      "restricted_attributes": [
        "url_credential"
      ]
    }
  }
}
```

--------------------------------

### Get Notifications Request

Source: https://developer.remotelock.com/api/docs

Example request to retrieve a list of all notifications.

```http
GET /notifications
```

--------------------------------

### Get Signed In User Response

Source: https://developer.remotelock.com/api/docs

Example of a successful response when fetching the signed-in user's details. Includes user information and account IDs.

```json
{
  "data": {
    "type": "user",
    "attributes": {
      "name": "Fausto Aufderhar VM",
      "email": "darwin@witting.com",
      "handle": "darwin",
      "created_at": "2000-01-01T00:00:00Z",
      "updated_at": "2000-01-01T00:00:00Z",
      "primary_account_id": "00000000-0000-0000-0000-000000000381",
      "default_account_id": "00000000-0000-0000-0000-000000000381"
    },
    "id": "00000000-0000-0000-0000-000000000382",
    "links": {
      "self": "http://api.remotelock.dev/user",
      "primary_account": "http://api.remotelock.dev/account",
      "default_account": "http://api.remotelock.dev/account"
    }
  }
}
```

--------------------------------

### Get a ReadyPIN Request Endpoint

Source: https://developer.remotelock.com/api/docs

Example of the endpoint to retrieve a specific Kore ReadyPIN by its ID.

```http
GET /kore_ready_pins/00000000-0000-0000-0000-000000000257
```

--------------------------------

### Account Response Example

Source: https://developer.remotelock.com/api/docs

This is an example of a successful response when retrieving account details. It includes account attributes and links.

```json
{
  "data": {
    "type": "account",
    "attributes": {
      "name": "Gov. Desmond Vandervort",
      "created_at": "2000-01-01T00:00:00Z",
      "updated_at": "2000-01-01T00:00:00Z",
      "default_guest_start_time": "15:30:00",
      "default_guest_end_time": "02:15:00",
      "rental_guest_time_override": false,
      "guest_management_enabled": false,
      "primary_owner_id": "00000000-0000-0000-0000-000000000075",
      "owner_role_id": "00000000-0000-0000-0000-000000000076"
    },
    "id": "00000000-0000-0000-0000-000000000077",
    "links": {
      "self": "http://api.remotelock.dev/account",
      "primary_owner": "http://api.remotelock.dev/user",
      "owner_role": "http://api.remotelock.dev/roles/00000000-0000-0000-0000-000000000076"
    }
  }
}
```

--------------------------------

### Device Response Example

Source: https://developer.remotelock.com/api/docs

This is an example of a successful response when retrieving device information, indicating a 201 Created status and providing detailed attributes of the lock.

```text
201 Created
```

```json
{
  "data": {
    "type": "lock",
    "attributes": {
      "name": "Home Lock",
      "heartbeat_interval": 1200,
      "wifi_level": 0,
      "signal_quality": 2,
      "connected": false,
      "alive": true,
      "power_source": "alkaline_battery",
      "connected_at": "2000-01-01T00:00:00Z",
      "location_name": "Face to face zero administration Graphic Interface",
      "model_number": "LS-5i",
      "serial_number": "NORMALIZED",
      "connectivity_enabled": true,
      "algorithmic_pin_enabled": true,
      "auto_lock": true,
      "auto_lock_timeout": 20,
      "created_at": "2000-01-01T00:00:00Z",
      "default_guest_end_time": null,
      "default_guest_start_time": null,
      "local_pins": [
        "1234"
      ],
      "mac_address": "f6:f7:b1:b8:97:e8",
      "manual_auto_lock_timeout": 0,
      "muted": false,
      "nfc": "no_nfc",
      "smd": "1100",
      "no_enter_code": false,
      "online_auto_lock": false,
      "power_level": 5,
      "programming_code": "123456",
      "state": "locked",
      "updated_at": "2000-01-01T00:00:00Z",
      "wake_wifi": "user_action",
      "wifi_enabled": true,
      "model_id": "00000000-0000-0000-0000-000000000091",
      "location_id": "00000000-0000-0000-0000-000000000090"
    },
    "id": "00000000-0000-0000-0000-000000000092",
    "links": {
      "self": "http://api.remotelock.dev/devices/00000000-0000-0000-0000-000000000092",
      "model": "http://api.remotelock.dev/models/00000000-0000-0000-0000-000000000091",
      "location": "http://api.remotelock.dev/locations/00000000-0000-0000-0000-000000000090"
    }
  }
}
```

--------------------------------

### Get All ReadyPINs Request Endpoint

Source: https://developer.remotelock.com/api/docs

Example of the endpoint to retrieve a list of all Kore ReadyPINs. Note that this endpoint is deprecated.

```http
GET /kore_ready_pins
```

--------------------------------

### Get Connector Lock Configuration Request

Source: https://developer.remotelock.com/api/docs

This example demonstrates the HTTP GET request to fetch the current dynamic configuration of a Connector Lock device. The device ID is a required parameter.

```http
GET /devices/00000000-0000-0000-0000-000000000147/configuration
```

--------------------------------

### Get Connector Lock Configurability Request

Source: https://developer.remotelock.com/api/docs

This example shows the HTTP GET request to retrieve the configurability options for a specific Connector Lock device. The endpoint requires the device ID.

```http
GET /devices/00000000-0000-0000-0000-000000000146/configurability
```

--------------------------------

### Successful Response Example

Source: https://developer.remotelock.com/api/docs

This is an example of a successful API response when retrieving access persons. It includes details for both 'access_user' and 'access_guest' types.

```json
{
  "data": [
    {
      "type": "access_user",
      "attributes": {
        "name": "Ronnie Lebsack",
        "email": "clarisa@example.net",
        "phone": null,
        "department": null,
        "deliver_as_qr_code": false,
        "status": "current",
        "source": null,
        "guest_source": null,
        "deliver_as_url_credential": false,
        "require_pin_verification": false,
        "schlage_engage_mobile_credentials_enabled": false,
        "korelock_wifi_credential_enabled": false,
        "ttlock_mobile_credential_enabled": false,
        "igloo_mobile_credentials_enabled": false,
        "august_mobile_credentials_enabled": false,
        "dormakaba_lyazon_mobile_credentials_enabled": false,
        "yonomi_mobile_credentials_enabled": false,
        "card_number_is_hex": false,
        "created_at": "2000-01-01T00:00:00Z",
        "updated_at": "2000-01-01T00:00:00Z",
        "pin": "NORMALIZED",
        "card_number": null,
        "schlage_engage_smart_card_id": null,
        "schlage_engage_smart_card_badge": null
      },
      "id": "00000000-0000-0000-0000-000000000012",
      "links": {
        "self": "http://api.remotelock.dev/access_persons/00000000-0000-0000-0000-000000000012"
      },
      "meta": {
        "restricted_attributes": [
          "url_credential"
        ]
      }
    },
    {
      "type": "access_guest",
      "attributes": {
        "name": "Tajuana Casper",
        "email": "michel@example.net",
        "phone": null,
        "department": null,
        "deliver_as_qr_code": false,
        "status": "upcoming",
        "source": null,
        "guest_source": null,
        "deliver_as_url_credential": false,
        "require_pin_verification": false,
        "schlage_engage_mobile_credentials_enabled": false,
        "korelock_wifi_credential_enabled": false,
        "ttlock_mobile_credential_enabled": false,
        "igloo_mobile_credentials_enabled": false,
        "august_mobile_credentials_enabled": false,
        "dormakaba_lyazon_mobile_credentials_enabled": false,
        "yonomi_mobile_credentials_enabled": false,
        "card_number_is_hex": false,
        "created_at": "2000-01-01T00:00:00Z",
        "updated_at": "2000-01-01T00:00:00Z",
        "pin": "NORMALIZED",
        "card_number": null,
        "schlage_engage_smart_card_id": null,
        "schlage_engage_smart_card_badge": null,
        "starts_at": "2000-01-01T00:00:00Z",
        "ends_at": "2000-01-01T00:00:00Z",
        "ready_pins": null
      },
      "id": "00000000-0000-0000-0000-000000000013",
      "links": {
        "self": "http://api.remotelock.dev/access_persons/00000000-0000-0000-0000-000000000013"
      },
      "meta": {
        "restricted_attributes": [
          "url_credential"
        ]
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 2,
    "total_pages": 1
  }
}
```

--------------------------------

### API Response Example

Source: https://developer.remotelock.com/api/docs

Example of a successful API response, typically a 200 OK status with JSON data.

```http
200 OK
```

```json
{
  "data": {
    "type": "access_instruction_guest_email_template",
    "attributes": {
      "subject": "Access instructions",
      "body": "NORMALIZED",
      "from_name": "See Walter",
      "reply_to": "kristal.okon@conroy.net",
      "cc": null,
      "bcc": null
    },
    "links": {
      "self": "http://api.remotelock.dev/access_instruction_guest_email_template/preview"
    }
  }
}
```

--------------------------------

### List Backup PINs Request

Source: https://developer.remotelock.com/api/docs

Example GET request to list all backup PINs assigned to a specific access person. Backup PINs are used for offline access.

```http
GET /access_persons/00000000-0000-0000-0000-000000000006/backup_pins
```

--------------------------------

### Get Event Response

Source: https://developer.remotelock.com/api/docs

Example JSON response for a single event, detailing the event type, status, timestamps, and associated resources.

```json
{
  "data": {
    "type": "unlocked_event",
    "attributes": {
      "source": "user",
      "status": "succeeded",
      "time_zone": "America/Denver",
      "occurred_at": "2000-01-01T00:00:00Z",
      "created_at": "2000-01-01T00:00:00Z",
      "updated_at": "2000-01-01T00:00:00Z",
      "associated_resource_name": null,
      "status_info": null,
      "method": "pin",
      "pin": "NORMALIZED",
      "card": null,
      "publisher_id": "00000000-0000-0000-0000-000000000222",
      "publisher_type": "lock",
      "associated_resource_id": "00000000-0000-0000-0000-000000000223",
      "associated_resource_type": "access_user"
    },
    "id": "00000000-0000-0000-0000-000000000221",
    "links": {
      "self": "http://api.remotelock.dev/events/00000000-0000-0000-0000-000000000221",
      "publisher": "http://api.remotelock.dev/devices/00000000-0000-0000-0000-000000000222",
      "associated_resource": "http://api.remotelock.dev/access_persons/00000000-0000-0000-0000-000000000223"
    }
  }
}
```

--------------------------------

### Example 200 OK Response for Models

Source: https://developer.remotelock.com/api/docs

This is an example of a successful response when retrieving lock models. It includes details about the model's name, type, and a comprehensive list of its capabilities.

```json
200 OK
```

```json
{
  "data": [
    {
      "type": "model",
      "attributes": {
        "name": "RL-4000",
        "number": "RL-4000",
        "type": "resort_lock",
        "capabilities": {
          "august_mobile_credential": false,
          "connected": false,
          "disable_network_lock_unlock": false,
          "dormakaba_lyazon_mobile_credential": false,
          "emulated_temporary_unlockable": false,
          "guest_deferrable": false,
          "hid_mobile_credential": false,
          "igloo_mobile_credential": false,
          "korelock_wifi_credential": false,
          "mobile_commissionable": true,
          "native_temporary_unlockable": false,
          "phone_credential": false,
          "pin_credential": false,
          "prox_card_credential": false,
          "ready_pin_credential": false,
          "registrable": true,
          "replaceable": false,
          "schlage_engage_mobile_credential": false,
          "schlage_engage_smart_card_credential": false,
          "smart_card_credential": false,
          "ttlock_mobile_credential": false,
          "unikey_credential": false,
          "wavelynx_mobile_credential": false,
          "yonomi_mobile_credential": false
        }
      },
      "id": "00000000-0000-0000-0000-000000000270",
      "links": {
        "self": "http://api.remotelock.dev/models/00000000-0000-0000-0000-000000000270"
      }
    },
    {
      "type": "model",
      "attributes": {
        "name": "ZWaveLock",
        "number": "ZWaveLock",
        "type": "zwave_lock",
        "capabilities": {
          "august_mobile_credential": false,
          "connected": true,
          "disable_network_lock_unlock": false,
          "dormakaba_lyazon_mobile_credential": false,
          "emulated_temporary_unlock_timeout_time": 10,
          "emulated_temporary_unlockable": true,
          "guest_deferrable": true,
          "hid_mobile_credential": false,
          "igloo_mobile_credential": false,
          "korelock_wifi_credential": false,
          "mobile_commissionable": true,
          "native_temporary_unlockable": false,
          "phone_credential": false,
          "pin_credential": true,
          "prox_card_credential": false,
          "ready_pin_credential": false,
          "registrable": false,
          "replaceable": false,
          "schlage_engage_mobile_credential": false,
          "schlage_engage_smart_card_credential": false,
          "smart_card_credential": false,
          "ttlock_mobile_credential": false,
          "unikey_credential": false,
          "wavelynx_mobile_credential": false,
          "yonomi_mobile_credential": false
        }
      },
      "id": "00000000-0000-0000-0000-000000000271",
      "links": {
        "self": "http://api.remotelock.dev/models/00000000-0000-0000-0000-000000000271"
      }
    },
    {
      "type": "model",
      "attributes": {
        "name": "BE467/FE410",
        "number": "SchlageControl",
        "type": "connector_lock",
        "capabilities": {
          "august_mobile_credential": false,
          "connected": false,
          "disable_network_lock_unlock": false,
          "dormakaba_lyazon_mobile_credential": false,
          "emulated_temporary_unlockable": false,
          "guest_deferrable": false,
          "hid_mobile_credential": false,
          "igloo_mobile_credential": false,
          "korelock_wifi_credential": false,
          "mobile_commissionable": true,
          "native_temporary_unlockable": false,
          "phone_credential": false,
          "pin_credential": false,
          "prox_card_credential": false,
          "ready_pin_credential": false,
          "registrable": false,
          "replaceable": false,
          "schlage_engage_mobile_credential": true,
          "schlage_engage_smart_card_credential": true,
          "smart_card_credential": false,
          "ttlock_mobile_credential": false,
          "unikey_credential": false,
          "uses_schlage_ble_firmware_updates": true,
          "wavelynx_mobile_credential": false,
          "yonomi_mobile_credential": false
        }
      },
      "id": "00000000-0000-0000-0000-000000000272",
      "links": {
        "self": "http://api.remotelock.dev/models/00000000-0000-0000-0000-000000000272"
      }
    },
    {
      "type": "model",
      "attributes": {
        "name": "RemoteLock KL Series 500i",
        "number": "RL-KL-Series-500i",
        "type": "connector_lock",
        "capabilities": {
          "access_exception": true,
          "august_mobile_credential": false,
          "connected": true,
          "disable_network_lock_unlock": false,
          "dormakaba_lyazon_mobile_credential": false,
          "emulated_temporary_unlockable": false,
          "guest_deferrable": false,
          "hid_mobile_credential": false,
          "igloo_mobile_credential": false,
          "korelock_wifi_credential": false,
          "mobile_commissionable": true,

```

--------------------------------

### Get a ReadyPIN

Source: https://developer.remotelock.com/api/docs

Retrieves a specific ReadyPIN by its ID.

```APIDOC
## Get a ReadyPIN

### Description
Retrieves a specific ReadyPIN by its ID.

### Method
GET

### Endpoint
`/kore_ready_pins/:id`

### Response
#### Success Response (200 OK)
- **data.type** (string) - Type of the resource.
- **data.attributes.uuid** (string) - Unique identifier for the ReadyPIN.
- **data.attributes.name** (string) - Name associated with the ReadyPIN.
- **data.attributes.email** (string) - Email associated with the ReadyPIN.
- **data.attributes.starts_at** (string) - Start date and time for access.
- **data.attributes.ends_at** (string) - End date and time for access.
- **data.attributes.status** (string) - Current status of the ReadyPIN (e.g., upcoming, current, expired).
- **data.attributes.source** (string) - Source of the ReadyPIN.
- **data.attributes.created_at** (string) - Timestamp of creation.
- **data.attributes.updated_at** (string) - Timestamp of last update.
- **data.attributes.pin** (string) - The ReadyPIN code.
- **data.attributes.lock_id** (string) - ID of the associated lock.
- **data.id** (string) - The unique identifier for the ReadyPIN.
- **data.links.self** (string) - URL to the ReadyPIN resource.
- **data.links.lock** (string) - URL to the associated lock resource.
```

--------------------------------

### Get Location Request

Source: https://developer.remotelock.com/api/docs

Example of a GET request to retrieve a specific location by its ID.

```http
GET /locations/00000000-0000-0000-0000-000000000266
```

--------------------------------

### Get Igloo Guest Request

Source: https://developer.remotelock.com/api/docs

Example of a GET request to retrieve a specific igloo guest by their ID.

```http
GET /igloo_guests/00000000-0000-0000-0000-000000000248
```

--------------------------------

### Get Access Exception Request

Source: https://developer.remotelock.com/api/docs

Example GET request to retrieve a specific access exception by its ID.

```http
GET /access_exceptions/00000000-0000-0000-0000-000000000002
```

--------------------------------

### Create ReadyPIN Response

Source: https://developer.remotelock.com/api/docs

This is an example of a successful 201 Created response after creating a ReadyPIN.

```json
{
  "data": {
    "type": "kore_ready_pin",
    "attributes": {
      "uuid": "00000000-0000-0000-0000-000000000260",
      "name": "Ann Smith",
      "email": "ann@smith.com",
      "starts_at": "2000-01-01T00:00:00Z",
      "ends_at": "2000-01-01T00:00:00Z",
      "status": "current",
      "source": null,
      "created_at": "2000-01-01T00:00:00Z",
      "updated_at": "2000-01-01T00:00:00Z",
      "pin": "NORMALIZED",
      "lock_id": "00000000-0000-0000-0000-000000000259"
    },
    "id": "00000000-0000-0000-0000-000000000260",
    "links": {
      "self": "http://api.remotelock.dev/kore_ready_pins/00000000-0000-0000-0000-000000000260",
      "lock": "http://api.remotelock.dev/devices/00000000-0000-0000-0000-000000000259"
    }
  }
}
```

--------------------------------

### Get Event Request

Source: https://developer.remotelock.com/api/docs

Example GET request to retrieve a specific event by its ID. The ID is a path parameter.

```http
GET /events/00000000-0000-0000-0000-000000000221
```

--------------------------------

### Get All Igloo Lock Guests Request

Source: https://developer.remotelock.com/api/docs

Example GET request to retrieve all igloo lock guests. No parameters are required.

```http
GET /igloo_guests
```

--------------------------------

### Create ReadyPIN Request

Source: https://developer.remotelock.com/api/docs

Use this endpoint to create a new ReadyPIN. Ensure all required attributes like name, lock_id, starts_at, and ends_at are provided.

```http
POST /kore_ready_pins
```

```json
{
  "attributes": {
    "name": "Ann Smith",
    "lock_id": "00000000-0000-0000-0000-000000000259",
    "starts_at": "2000-01-01T00:00:00Z",
    "ends_at": "2000-01-01T00:00:00Z",
    "email": "ann@smith.com"
  }
}
```

--------------------------------

### Get Door Group Item Request

Source: https://developer.remotelock.com/api/docs

Example GET request to retrieve a specific item within a door group. No parameters are required.

```http
GET /groups/00000000-0000-0000-0000-000000000235/items/00000000-0000-0000-0000-000000000236
```

--------------------------------

### Get Resort Lock Guest Request

Source: https://developer.remotelock.com/api/docs

This is an example of a GET request to retrieve a specific resort lock guest by their ID. This endpoint does not require any parameters.

```http
GET /resort_lock_guests/00000000-0000-0000-0000-000000000361
```

--------------------------------

### Get Resort Lock Guests Request

Source: https://developer.remotelock.com/api/docs

This is an example of a GET request to retrieve all resort lock guests. The 'sort' parameter can be used to order the results.

```http
GET /resort_lock_guests
```

--------------------------------

### Example Response for Backup PINs

Source: https://developer.remotelock.com/api/docs

A 200 OK response containing a list of backup PINs with their attributes and associated links.

```json
{
  "data": [
    {
      "type": "backup_pin",
      "attributes": {
        "uuid": "00000000-0000-0000-0000-000000000007",
        "created_at": "2000-01-01T00:00:00Z",
        "updated_at": "2000-01-01T00:00:00Z",
        "pin": "NORMALIZED",
        "device_id": "00000000-0000-0000-0000-000000000008",
        "device_type": "zwave_lock"
      },
      "id": "00000000-0000-0000-0000-000000000007",
      "links": {
        "self": "http://api.remotelock.dev/backup_pins/00000000-0000-0000-0000-000000000007",
        "device": "http://api.remotelock.dev/devices/00000000-0000-0000-0000-000000000008"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 1,
    "total_pages": 1
  }
}
```

--------------------------------

### Create a ReadyPIN

Source: https://developer.remotelock.com/api/docs

Creates a new ReadyPIN for a given lock. The `starts_at` and `ends_at` parameters define the validity period of the PIN.

```APIDOC
## Create a ReadyPIN
### Request
#### Endpoint
`POST /kore_ready_pins`
```
POST /kore_ready_pins


```

#### Parameters
```
{
  "attributes": {
    "name": "Ann Smith",
    "lock_id": "00000000-0000-0000-0000-000000000259",
    "starts_at": "2000-01-01T00:00:00Z",
    "ends_at": "2000-01-01T00:00:00Z",
    "email": "ann@smith.com"
  }
}

```

Name | Description  
---|---
attributes[name] _required_ | Name  
attributes[lock_id] _required_ | Lock  
attributes[starts_at] _required_ | Starts at ISO 8601 timestamp without time zone (only hours are supported).  
attributes[ends_at] _required_ | Ends at ISO 8601 timestamp without time zone (only hours are supported).  
attributes[email] | Email  
### Response
```

201 Created

```

```
{
  "data": {
    "type": "kore_ready_pin",
    "attributes": {
      "uuid": "00000000-0000-0000-0000-000000000260",
      "name": "Ann Smith",
      "email": "ann@smith.com",
      "starts_at": "2000-01-01T00:00:00Z",
      "ends_at": "2000-01-01T00:00:00Z",
      "status": "current",
      "source": null,
      "created_at": "2000-01-01T00:00:00Z",
      "updated_at": "2000-01-01T00:00:00Z",
      "pin": "NORMALIZED",
      "lock_id": "00000000-0000-0000-0000-000000000259"
    },
    "id": "00000000-0000-0000-0000-000000000260",
    "links": {
      "self": "http://api.remotelock.dev/kore_ready_pins/00000000-0000-0000-0000-000000000260",
      "lock": "http://api.remotelock.dev/devices/00000000-0000-0000-0000-000000000259"
    }
  }
}

```
```

--------------------------------

### Get Access Person Request

Source: https://developer.remotelock.com/api/docs

This is an example of a GET request to retrieve a specific access person by their ID. The response will contain the details of the requested access person.

```http
GET /access_persons/00000000-0000-0000-0000-000000000016
```

--------------------------------

### Update ReadyPIN Response

Source: https://developer.remotelock.com/api/docs

This is an example of a successful 200 OK response after updating a ReadyPIN.

```json
{
  "data": {
    "type": "kore_ready_pin",
    "attributes": {
      "uuid": "00000000-0000-0000-0000-000000000261",
      "name": "Mike Smith",
      "email": "mike@smith.com",
      "starts_at": "2000-01-01T00:00:00Z",
      "ends_at": "2000-01-01T00:00:00Z",
      "status": "current",
      "source": null,
      "created_at": "2000-01-01T00:00:00Z",
      "updated_at": "2000-01-01T00:00:00Z",
      "pin": "NORMALIZED",
      "lock_id": "00000000-0000-0000-0000-000000000262"
    },
    "id": "00000000-0000-0000-0000-000000000261",
    "links": {
      "self": "http://api.remotelock.dev/kore_ready_pins/00000000-0000-0000-0000-000000000261",
      "lock": "http://api.remotelock.dev/devices/00000000-0000-0000-0000-000000000262"
    }
  }
}
```

--------------------------------

### Create Access Guest Parameters

Source: https://developer.remotelock.com/api/docs

Defines the parameters for creating an access guest. Ensure 'starts_at', 'ends_at', and a valid identifier like 'name' and 'pin' are provided.

```json
{
  "type": "access_guest",
  "attributes": {
    "starts_at": "2000-01-01T00:00:00Z",
    "ends_at": "2000-01-01T00:00:00Z",
    "name": "Ann Smith",
    "pin": "NORMALIZED"
  }
}

```

--------------------------------

### Create Access User Request

Source: https://developer.remotelock.com/api/docs

This is an example of a POST request to create a new access user. Access users are permanent and do not accept 'starts_at' or 'ends_at' parameters, unlike access guests.

```http
POST /access_persons
```

--------------------------------

### Get Igloo Guest Response

Source: https://developer.remotelock.com/api/docs

Example of a successful response when retrieving a single igloo guest.

```json
{
  "data": {
    "type": "igloo_guest",
    "attributes": {
      "name": "Annabel Hessel",
      "email": "kayce@tremblay.info",
      "starts_at": "2000-01-01T00:00:00Z",
      "ends_at": "2000-01-01T00:00:00Z",
      "igloo_lock_id": "00000000-0000-0000-0000-000000000249",
      "igloo_mobile_credentials_enabled": false,
      "created_at": "2000-01-01T00:00:00Z",
      "updated_at": "2000-01-01T00:00:00Z",
      "code": "678123",
      "pin": "NORMALIZED"
    },
    "id": "00000000-0000-0000-0000-000000000248",
    "links": {
      "self": "http://api.remotelock.dev/igloo_guests/00000000-0000-0000-0000-000000000248"
    }
  }
}
```

--------------------------------

### Preview Access Instructions Email Request

Source: https://developer.remotelock.com/api/docs

Example endpoint for previewing the access instructions email for a resort lock guest. No request body is required.

```http
GET /resort_lock_guests/00000000-0000-0000-0000-000000000369/email/preview
```

--------------------------------

### Send Access Instructions Email Request

Source: https://developer.remotelock.com/api/docs

Example endpoint for sending access instructions via email to a resort lock guest. No request body is required.

```http
POST /resort_lock_guests/00000000-0000-0000-0000-000000000368/email/notify
```

--------------------------------

### Get Door Group Item Response

Source: https://developer.remotelock.com/api/docs

Example JSON response for a successful retrieval of a single door group item.

```json
{
  "data": {
    "type": "door_group_item",
    "attributes": {
      "created_at": "2000-01-01T00:00:00Z",
      "updated_at": "2000-01-01T00:00:00Z",
      "item_id": "00000000-0000-0000-0000-000000000237",
      "item_type": "lock",
      "door_group_id": "00000000-0000-0000-0000-000000000235"
    },
    "id": "00000000-0000-0000-0000-000000000236",
    "links": {
      "self": "http://api.remotelock.dev/groups/00000000-0000-0000-0000-000000000235/items/00000000-0000-0000-0000-000000000236",
      "item": "http://api.remotelock.dev/devices/00000000-0000-0000-0000-000000000237",
      "door_group": "http://api.remotelock.dev/groups/00000000-0000-0000-0000-000000000235"
    }
  }
}
```

--------------------------------

### Get All Brands Response

Source: https://developer.remotelock.com/api/docs

This is an example of a successful response when retrieving all brands. It includes a list of brand objects and pagination metadata.

```json
{
  "data": [
    {
      "type": "brand",
      "attributes": {
        "name": "Brand 1",
        "vendor": "ayla",
        "uuid": "00000000-0000-0000-0000-000000000078"
      },
      "id": "00000000-0000-0000-0000-000000000078",
      "links": {
        "self": "http://api.remotelock.dev/brands/00000000-0000-0000-0000-000000000078"
      }
    },
    {
      "type": "brand",
      "attributes": {
        "name": "Brand 1",
        "vendor": "ayla",
        "uuid": "00000000-0000-0000-0000-000000000079"
      },
      "id": "00000000-0000-0000-0000-000000000079",
      "links": {
        "self": "http://api.remotelock.dev/brands/00000000-0000-0000-0000-000000000079"
      }
    },
    {
      "type": "brand",
      "attributes": {
        "name": "Brand 1",
        "vendor": "ayla",
        "uuid": "00000000-0000-0000-0000-000000000080"
      },
      "id": "00000000-0000-0000-0000-000000000080",
      "links": {
        "self": "http://api.remotelock.dev/brands/00000000-0000-0000-0000-000000000080"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 3,
    "total_pages": 1
  }
}
```

--------------------------------

### Create ResortLock Guest POST Request

Source: https://developer.remotelock.com/api/docs

Send this POST request to create a guest for a ResortLock. Ensure the resort_lock_id matches your ResortLock's ID and replace $ACCESS_TOKEN with your valid token. Time values for starts_at and ends_at should not include minutes or seconds.

```bash
curl -X POST \
  -H 'Authorization: Bearer $ACCESS_TOKEN' \
  -H 'Accept: application/vnd.remotelock+json; version=1' \
  -H 'Content-Type: application/json' \
  -d '{
    "attributes": {
      "resort_lock_id": "ed1b7a1b-0dc5-4081-8658-728d96ed0dde",
      "name": "My ResortLock Guest",
      "starts_at": "2020-01-02T13:00:00",
      "ends_at": "2021-01-02T16:00:00"
    }
  }' \
  'https://api.remotelock.com/resort_lock_guests'
```

--------------------------------

### Get Location Response

Source: https://developer.remotelock.com/api/docs

Example of a successful response when retrieving a single location by ID. Contains the full details of the specified location.

```json
{
  "data": {
    "type": "location",
    "attributes": {
      "name": "RemoteLock Headquarters",
      "phone": "(877) 254-5625",
      "address": "1325 S. Colorado Blvd",
      "address2": "Suite B400",
      "city": "Denver",
      "state": "CO",
      "postal_code": "80222",
      "country": "US",
      "time_zone": "America/Denver",
      "created_at": "2000-01-01T00:00:00Z",
      "updated_at": "2000-01-01T00:00:00Z"
    },
    "id": "00000000-0000-0000-0000-000000000266",
    "links": {
      "self": "http://api.remotelock.dev/locations/00000000-0000-0000-0000-000000000266"
    }
  }
}
```

--------------------------------

### Example Response for Created Backup PIN Assignment

Source: https://developer.remotelock.com/api/docs

A 201 Created response indicating successful assignment of backup PINs.

```http
201 Created
```

--------------------------------

### Get Notification Subscription Response

Source: https://developer.remotelock.com/api/docs

Example JSON response for retrieving a notification subscription. It details the events, creation/update times, and subscriber/publisher information.

```json
{
  "data": {
    "type": "notification_subscription",
    "attributes": {
      "events": [
        {
          "event_type": "access_person_used"
        },
        {
          "event_type": "acs_door_held_open"
        }
      ],
      "created_at": "2000-01-01T00:00:00Z",
      "updated_at": "2000-01-01T00:00:00Z",
      "subscriber_id": "00000000-0000-0000-0000-000000000345",
      "subscriber_type": "text_notification_subscriber",
      "publisher_id": "00000000-0000-0000-0000-000000000346",
      "publisher_type": "account"
    },
    "id": "00000000-0000-0000-0000-000000000344",
    "links": {
      "self": "http://api.remotelock.dev/notification_subscriptions/00000000-0000-0000-0000-000000000344",
      "subscriber": "http://api.remotelock.dev/notification_subscribers/00000000-0000-0000-0000-000000000345",
      "publisher": "http://api.remotelock.dev/accounts/00000000-0000-0000-0000-000000000346"
    }
  }
}
```