Endpoints
Read how a unit code update went
Read whether the last door-code update of one Unit reached its Locks: queued, running or settled, success or failed, Codes in place of planned, the Locks that failed and why, and the org's Code horizon. Unknown when no recent run is on record. Carries no Code digits. Requires `locks:write`.
GET /v1/passcodes/read_unit_code_status
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
unitId | query | Yes | string | Unit id or URL key. |
Request examples
Set MYREMOTELY_BASE_URL to the environment you intend to call.
curl --fail-with-body \
--header "x-api-key: $MYREMOTELY_API_KEY" \
"$MYREMOTELY_BASE_URL/v1/passcodes/read_unit_code_status"const baseUrl = process.env.MYREMOTELY_BASE_URL
const apiKey = process.env.MYREMOTELY_API_KEY
if (!baseUrl || !apiKey) throw new Error('API base URL and key are required')
const response = await fetch(`${baseUrl}/v1/passcodes/read_unit_code_status`, {
method: 'GET',
headers: { 'x-api-key': apiKey },
})
if (!response.ok) throw new Error(`Request failed: ${response.status}`)
const data = await response.json()Responses
200 Success
application/json
| Field | Type | Required | Description |
|---|---|---|---|
state | string | Yes | — |
outcome | anyOf | Yes | — |
summary | anyOf | Yes | — |
codesConverged | anyOf | Yes | — |
codesTotal | anyOf | Yes | — |
lockCount | anyOf | Yes | — |
failures | array | Yes | — |
willRetry | boolean | Yes | — |
queuedAt | anyOf | Yes | — |
startedAt | anyOf | Yes | — |
finishedAt | anyOf | Yes | — |
queueReachable | boolean | Yes | — |
limits | object | Yes | — |
unitId | string | Yes | — |
{
"state": "string",
"outcome": "string",
"summary": "string",
"codesConverged": "string",
"codesTotal": "string",
"lockCount": "string",
"failures": [
{
"lockId": "string",
"lockName": "string",
"reason": "string",
"message": "string"
}
],
"willRetry": false,
"queuedAt": "string",
"startedAt": "string",
"finishedAt": "string",
"queueReachable": false,
"limits": {
"dayHorizonDays": 0
},
"unitId": "string"
}400 The list limit is outside the supported range or is not an integer.
application/problem+json
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | A stable documentation URI for this problem. |
title | string | Yes | A short problem title. |
detail | string | Yes | A safe explanation of this occurrence. |
code | string | Yes | A stable machine-readable problem code. |
requestId | string | Yes | The request ID to include when contacting MyRemotely support. |
status | number | Yes | The HTTP status code. |
{
"type": "https://app.myremotely.ai/en/docs/errors#invalid-request",
"title": "Invalid request",
"status": 400,
"detail": "The limit must be an integer from 1 to 100.",
"code": "invalid_request",
"requestId": "request_demo_01"
}401 The API key is missing, invalid, expired, or revoked.
application/problem+json
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | A stable documentation URI for this problem. |
title | string | Yes | A short problem title. |
detail | string | Yes | A safe explanation of this occurrence. |
code | string | Yes | A stable machine-readable problem code. |
requestId | string | Yes | The request ID to include when contacting MyRemotely support. |
status | number | Yes | The HTTP status code. |
{
"type": "https://app.myremotely.ai/en/docs/errors#invalid-api-key",
"title": "Unauthorized",
"status": 401,
"detail": "Provide a valid API key.",
"code": "invalid_api_key",
"requestId": "request_demo_01"
}403 The API key does not have the locks:write scope.
application/problem+json
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | A stable documentation URI for this problem. |
title | string | Yes | A short problem title. |
detail | string | Yes | A safe explanation of this occurrence. |
code | string | Yes | A stable machine-readable problem code. |
requestId | string | Yes | The request ID to include when contacting MyRemotely support. |
status | number | Yes | The HTTP status code. |
{
"type": "https://app.myremotely.ai/en/docs/errors#missing-scope",
"title": "Forbidden",
"status": 403,
"detail": "The locks:write scope is required.",
"code": "missing_scope",
"requestId": "request_demo_01"
}429 The API key request budget is exhausted.
application/problem+json
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | A stable documentation URI for this problem. |
title | string | Yes | A short problem title. |
detail | string | Yes | A safe explanation of this occurrence. |
code | string | Yes | A stable machine-readable problem code. |
requestId | string | Yes | The request ID to include when contacting MyRemotely support. |
status | number | Yes | The HTTP status code. |
{
"type": "https://app.myremotely.ai/en/docs/errors#rate-limited",
"title": "Too many requests",
"status": 429,
"detail": "Try the request again later.",
"code": "rate_limited",
"requestId": "request_demo_01"
}500 MyRemotely could not complete the request.
application/problem+json
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | A stable documentation URI for this problem. |
title | string | Yes | A short problem title. |
detail | string | Yes | A safe explanation of this occurrence. |
code | string | Yes | A stable machine-readable problem code. |
requestId | string | Yes | The request ID to include when contacting MyRemotely support. |
status | number | Yes | The HTTP status code. |
{
"type": "https://app.myremotely.ai/en/docs/errors#internal-error",
"title": "Internal error",
"status": 500,
"detail": "The request could not be completed.",
"code": "internal_error",
"requestId": "request_demo_01"
}Last updated Oct 3, 2026