Get a User

get/public/v1/users/{user}

get/public/v1/users/{user}

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

Response

{
  "data": {
    "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "status": "active",
    "employment_title": "Service Manager",
    "employment_type": "employee",
    "employment_start_date": "2024-07-01",
    "dob": "1990-05-17",
    "phone": "0298765432",
    "mobile": "0412345678",
    "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"
    },
    "contacts": [
      {
        "id": "c1o2n3t4-a5c6-47t8-9a0b-1c2d3e4f5a6b",
        "name": "Margaret Doe",
        "relationship": "Mother",
        "phone": "0412345678",
        "email": "margaret.doe@example.com",
        "role": "emergency_contact"
      }
    ]
  }
}

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

userstringrequired
The user UUID

Response

200application/json

UserDetailResource

dataobjectrequired
▶Show 13 child attributesHide child attributes
- idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- first_namestringrequired
  Example:John
- last_namestringrequired
  Example:Doe
- emailstringrequired
  Example:john.doe@example.com
- statusenum<string>required
  Available options:activedeactivatedinvitedrestricted
- employment_titlestring | nullrequired
  Example:Service Manager
- employment_typeenum<string> | nullrequired
  Available options:contractoremployee
- employment_start_datestring | nullrequired
  Example:2024-07-01
- dobstring | nullrequired
  Example:1990-05-17
- phonestring | nullrequired
  Example:0298765432
- mobilestring | nullrequired
  Example:0412345678
- addressobject | null
  Present only when the API key's user can view this user's address.
  ▶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
  stateenum<string>required
  Available options:ACTNSWNTQLDSATASVICWA
  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
- contactsobject[]required
  ▶Show 6 child attributesHide child attributes
  idstringrequired
  Example:c1o2n3t4-a5c6-47t8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:Margaret Doe
  relationshipstring | nullrequired
  Example:Mother
  phonestring | nullrequired
  Example:0412345678
  emailstring | nullrequired
  Example:margaret.doe@example.com
  roleenum<string>required
  Available options:emergency_contactnext_of_kin

Errors

401Unauthenticated
403Authorization error
404Not found