SCscanopy
Sites

Get site by ID

Changed on
get/api/v1/sites/{id}

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/sites/{id}
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Path parameters

idstring uuid required

Site ID

Response

Site found

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "data": {
    "created_at": "2026-01-15T10:30:00Z",
    "credential_ids": [],
    "effective_stale_after_hours": 672,
    "id": "550e8400-e29b-41d4-a716-446655440002",
    "name": "Home Site",
    "organization_id": "550e8400-e29b-41d4-a716-446655440001",
    "stale_after_hours": null,
    "tags": [],
    "updated_at": "2026-01-15T10:30:00Z"
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • c9d9d46d1ae8Revision changes
    • info

      api operation id get_by_id_site removed and replaced with get_site_by_id

  • c305a1f5ae29Revision changes
    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became optional for the status