Get a Site

get/public/v1/sites/{site}

get/public/v1/sites/{site}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/sites/{site}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
    "name": "Main Street House",
    "type": "sil_house",
    "default_support_type": "community_access",
    "description": "A supported independent living house",
    "capacity": 4,
    "address": {
      "id": "a1d2d3r4-e5s6-47s8-9a0b-1c2d3e4f5a6b",
      "address_1": "12 Harbour View Drive",
      "address_2": "Unit 4",
      "suburb": "Lavender Bay",
      "state": "NSW",
      "postcode": "2060",
      "country": "Australia",
      "lat": "-33.8447",
      "lng": "151.2094",
      "traditional_place_name": "Gadigal Country",
      "details": "Enter via the side gate"
    },
    "site_manager": {
      "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "tags": [
      {
        "id": "s1i2t3e4-t5a6-47g8-9b0c-1d2e3f4a5b6c",
        "name": "Vacancy",
        "colour": "#e30425",
        "created_at": "2024-01-15T10:30:00+00:00"
      }
    ],
    "archived_at": "2024-06-01T00:00:00+00:00",
    "created_at": "2024-01-15T10:30:00+00:00"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

sitestringrequired
The site UUID

Response

200application/json

SiteResource

dataobjectrequired
▶Show 11 child attributesHide child attributes
- idstringrequired
  Example:s1a2b3c4-d5e6-47f8-9a0b-1c2d3e4f5a6b
- namestringrequired
  Example:Main Street House
- typestringrequired
  Example:sil_house
- default_support_typestring | nullrequired
  Example:community_access
- descriptionstring | nullrequired
  Example:A supported independent living house
- capacityinteger | nullrequired
  Example:4
- addressobject | nullrequired
  ▶Show 11 child attributesHide child attributes
  idstringrequired
  Example:a1d2d3r4-e5s6-47s8-9a0b-1c2d3e4f5a6b
  address_1stringrequired
  Example:12 Harbour View Drive
  address_2string | nullrequired
  Example:Unit 4
  suburbstring | nullrequired
  Example:Lavender Bay
  statestringrequired
  Example:NSW
  postcodestringrequired
  Example:2060
  countrystringrequired
  Example:Australia
  latstring | nullrequired
  Example:-33.8447
  lngstring | nullrequired
  Example:151.2094
  traditional_place_namestring | nullrequired
  Example:Gadigal Country
  detailsstring | nullrequired
  Example:Enter via the side gate
- site_managerobject | nullrequired
  ▶Show 3 child attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:John Doe
  emailstringrequired
  Example:john.doe@example.com
- tagsobject[]required
  ▶Show 4 child attributesHide child attributes
  idstringrequired
  Example:s1i2t3e4-t5a6-47g8-9b0c-1d2e3f4a5b6c
  namestringrequired
  Example:Vacancy
  colourstring | nullrequired
  Example:#e30425
  created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- archived_atstring | nullrequired
  Example:2024-06-01T00:00:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Response

Errors