--- title: Returns Site details slug: api/returns-site-details docTags: createdAt: 2026-03-01T03:12:36.506Z --- { "id": "26UAexTVQsgEVzr-UtlWB", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://openapi.sine.co/v1/api/sites/{siteId}", "servers": [ { "url": "https://openapi.sine.co/v1/api/sites/{siteId}", "description": "Sine Public API" } ], "name": "Returns Site details", "description": "Fetches the details of the Site specified by the provided siteId parameter", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "siteId", "type": "string", "example": "85543775-dad8-40de-8be4-7ac29dd7d466", "description": "Unique identifier for a Site", "format": "uuid" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-sine-team-id", "type": "string", "description": "The UUID of the Team", "format": "uuid" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "bearerAuth", "name": "bearerAuth", "kind": "optional", "type": "http", "description": "

To obtain a token, call POST /oauth2/token with your client_id and client_secret. The returned access_token is then used as a Bearer token for all subsequent requests.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

OK - Site details returned successfully

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "visitorTypes", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for a Visitor Type", "example": "019fe2b4-f2ee-4a19-873d-ddb4f014dfce", "format": "uuid" }, { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "Visitor" }, { "name": "hostRequired", "kind": "optional", "type": "boolean", "description": "

If true, specification of a valid host is required upon check-in for this visitor type

", "example": true } ] }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for a Site", "example": "019fe2b4-f2ee-4a19-873d-ddb4f014dfce", "format": "uuid" }, { "name": "name", "kind": "optional", "type": "string", "description": "name of the Site", "example": "Sine" }, { "name": "address", "kind": "optional", "type": "string", "description": "

the address (physical location) of the Site

", "example": "100 Pirie St, Adelaide SA 5000" }, { "name": "latitude", "kind": "optional", "type": "number", "description": "location coordinates of the Site", "example": -34.925, "format": "float" }, { "name": "longitude", "kind": "optional", "type": "number", "description": "location coordinates of the Site", "example": 138.604, "format": "float" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"BAD_REQUEST\",\"message\":\"The request is invalid\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "BAD_REQUEST" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom Error Message", "example": "The request is invalid" } ], "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"UNAUTHORIZED\",\"message\":\"Invalid authentication credentials\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "UNAUTHORIZED" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "Invalid authentication credentials" } ], "isExpanded": true } ] }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"FORBIDDEN\",\"message\":\"You are not allowed to access this information\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "FORBIDDEN" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "You are not allowed to access this information" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Resource not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"SITE_NOT_FOUND\",\"message\":\"SiteNotFoundError\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "SITE_NOT_FOUND" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "SiteNotFoundError" } ], "isExpanded": true } ] }, { "statusCode": "424", "description": "Service dependency failed", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"CONSUMER_ERROR\",\"message\":\"Unexpected error while communicating with downstream service, please try again\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "CONSUMER_ERROR" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "Unexpected error while communicating with downstream service, please try again" } ], "isExpanded": true } ] }, { "statusCode": "429", "description": "Too many requests", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"RATE_LIMITED\",\"message\":\"API rate limit exceeded\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "RATE_LIMITED" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "API rate limit exceeded" } ], "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"INTERNAL_SERVER_ERROR\",\"message\":\"Something went wrong, please try again later\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "INTERNAL_SERVER_ERROR" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "Something went wrong, please try again later" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "9oD91r-GdBc36LdoWBpyP", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://openapi.sine.co/v1/api/sites/{siteId} \\\n --header 'accept: application/json' \\\n --header 'x-sine-team-id: string'" }, { "id": "VkmrW9i-zlMfjil8aZz8r", "language": "javascript", "label": "JavaScript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-sine-team-id\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://openapi.sine.co/v1/api/sites/{siteId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "yBm2rd-tmGO6neJRDb3mn", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://openapi.sine.co/v1/api/sites/{siteId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-sine-team-id': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "9oD91r-GdBc36LdoWBpyP" }, "results": { "languages": [ { "id": "xwO-G9wvKo2g_ZAcbemde", "language": "200", "code": "// OK - Site details returned successfully\n{\n \"visitorTypes\": [\n {\n \"id\": \"019fe2b4-f2ee-4a19-873d-ddb4f014dfce\",\n \"name\": \"Visitor\",\n \"hostRequired\": true\n }\n ],\n \"id\": \"019fe2b4-f2ee-4a19-873d-ddb4f014dfce\",\n \"name\": \"Sine\",\n \"address\": \"100 Pirie St, Adelaide SA 5000\",\n \"latitude\": -34.925,\n \"longitude\": 138.604\n}" }, { "id": "L3yGptSNVlamE2t0Z0duj", "language": "400", "code": "// Bad request\n{\n \"code\": \"BAD_REQUEST\",\n \"message\": \"The request is invalid\"\n}" }, { "id": "fvO-v2wfR_O6xezAEClke", "language": "401", "code": "// Unauthorized\n{\n \"code\": \"UNAUTHORIZED\",\n \"message\": \"Invalid authentication credentials\"\n}" }, { "id": "S1O7jgd4N40JWAev0LWGx", "language": "403", "code": "// Forbidden\n{\n \"code\": \"FORBIDDEN\",\n \"message\": \"You are not allowed to access this information\"\n}" }, { "id": "DkbKw9Ukz5z1EAaA8lAtO", "language": "404", "code": "// Resource not found\n{\n \"code\": \"SITE_NOT_FOUND\",\n \"message\": \"SiteNotFoundError\"\n}" }, { "id": "nF0Viej4jentRTaEI54ue", "language": "424", "code": "// Service dependency failed\n{\n \"code\": \"CONSUMER_ERROR\",\n \"message\": \"Unexpected error while communicating with downstream service, please try again\"\n}" }, { "id": "yptq3MNQRwdsAW9z_m5bI", "language": "429", "code": "// Too many requests\n{\n \"code\": \"RATE_LIMITED\",\n \"message\": \"API rate limit exceeded\"\n}" }, { "id": "Mcn89JDC2h_drAFe8P4Fs", "language": "500", "code": "// Internal server error\n{\n \"code\": \"INTERNAL_SERVER_ERROR\",\n \"message\": \"Something went wrong, please try again later\"\n}" } ], "selectedLanguageId": "xwO-G9wvKo2g_ZAcbemde" } }, "children": [ { "text": "" } ] }