Endpoints

List blackout days of a unit

List the blackout ranges of one Unit, by its urlKey: the days no Tour can be booked. Returns current and future ranges only, soonest first, each with id, start and end date (both included) and reason. Requires `units:write`.

GET /v1/units/list_showing_blackouts

Parameters

Name	In	Required	Type	Description
`urlKey`	query	Yes	`string`	The Unit's urlKey: the kebab-case slug in its page address, e.g. 123-main-st.

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/units/list_showing_blackouts"

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/units/list_showing_blackouts`, {
  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
`blackouts`	`array`	Yes	—

{
  "blackouts": [
    {
      "id": "string",
      "startDate": "string",
      "endDate": "string",
      "reason": "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 `units: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 units: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

List blackout days of a unit

Parameters

Request examples

Responses

200 Success

400 The list limit is outside the supported range or is not an integer.

401 The API key is missing, invalid, expired, or revoked.

403 The API key does not have the units:write scope.

429 The API key request budget is exhausted.

500 MyRemotely could not complete the request.

403 The API key does not have the `units:write` scope.