Community Member

GET 
/community/:communityId

Fetches a given community members profile, occupation and education information.

Request

Path Parameters

communityId uuidrequired

The unique identifier of the community member.

Responses

200

application/json

Schema

Schema

code stringrequired

Status Code

data object
communityId uuidrequired
isCompany booleanrequired
schoolId string
personalInfo objectnullablerequired
spouseCommunityId uuidnullablerequired
schoolId stringrequired
givenName stringrequired
surname stringnullablerequired
prefName stringnullablerequired
otherGivenName stringnullablerequired
nameSuffix stringnullablerequired
overrideLegalSurname stringnullablerequired
overrideMailFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
overrideSalutationFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
overrideSalutationPreferredFormat objectnullablerequired
id integernullablerequired
description stringnullablerequired
familyNamePrevious stringnullablerequired
maidenName stringnullablerequired
isPrimary booleanrequired
initials stringrequired
title objectnullablerequired
id stringnullablerequired
description stringnullablerequired
displayName stringrequired
displayNameForList stringrequired
birthDate daterequired
gender objectnullablerequired
id stringnullablerequired
description stringnullablerequired
deceasedDate datenullablerequired
deceased booleanrequired
companyInfo objectnullablerequired
schoolId stringrequired
companyName stringrequired
companyAttention stringnullablerequired
addressInfo objectrequired
The community member's address information
postalAddressChecked boolean
Is the postal address set to be the same as the home address?
addresses object[]
List of the community member's addresses
Array [
systemMeaning stringnullablerequired
The type of address: 'Postal' for postal addresses, 'Home' for residential addresses, or null for other custom types.
id uuidrequired
UUID of the community member's address record
addressId uuidrequired
UUID of the record containing details for a given address (street name/number, postcode, etc)
addressType objectnullablerequired
The lookup for the address type (null if systemMeaning is not 'home' or 'postal')
id
UUID of the address type lookup
description
The address type (e.g. Alternative Home Address, Occupation Address, etc)
code
The address type code (e.g. ALT, OCC)
addressLine1 stringnullablerequired
addressLine2 stringnullablerequired
addressLine3 stringnullablerequired
suburb stringnullablerequired
Burwood East
postalCode stringnullablerequired
confidential booleannullablerequired
country objectnullablerequired
id
UUID of the country lookup
description
Country name (e.g. Australia)
code
Country code (e.g. AU)
state objectnullablerequired
id
UUID of the state lookup
description
State name (e.g. Tasmania)
code
Country code (e.g. TAS)
displayAddressComma stringrequired
The community member's full address with commas separating the fields
displayAddressFull stringrequired
The community member's full address with each field on a new line
]
contactDetails objectrequired
deceased booleannullable
Is this community member deceased?
emailAddress object[]nullable
List of the community member's email addresses
Array [
id uuid
UUID of the community member's email address record
emailType object
id
UUID of the email address type lookup
description
The email address type (e.g. Personal, Occupation, Company, etc)
value stringnullable
The community member's email address
default booleannullable
Is this the default email address?
sortOrder integernullable
]
internetAndSocialMedia object[]nullable
List of the community member's website/s and social media account/s
Array [
id uuid
UUID of the community member's website or social media account record
websiteType object
id
UUID for community website type lookup
description
The community website type (e.g. Facebook, LinkedIn, etc.)
value stringnullable
A URL to the website or social media account
sortOrder int32
Sort order for the website or social media account
]
phoneNumber object[]nullable
List of the community member's phone number/s
Array [
phoneType objectnullablerequired
id uuid
UUID of the phone contact type lookup
description string
The phone contact type (e.g. Home Phone, Personal Mobile, etc)
code string
The unique code indicating the phone contact type (e.g. PERSONALMOBILE)
value stringnullablerequired
Phone number
confidential booleanrequired
preferred booleanrequired
defaultSMS booleanrequired
Is this the default SMS number?
extension stringnullablerequired
Optional extension for the phone number
countryCode stringnullablerequired
The country calling code prefix for the phone number
country objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
]
demographics objectnullablerequired
overrideRegion booleanrequired
religion objectnullablerequired
id stringnullablerequired
description stringnullablerequired
indigenousStatus objectnullablerequired
id stringnullablerequired
description stringnullablerequired
parish objectnullablerequired
id stringnullablerequired
description stringnullablerequired
region objectnullablerequired
id stringnullablerequired
description stringnullablerequired
birthCountry objectnullablerequired
id stringnullablerequired
description stringnullablerequired
addresses object[]nullablerequired
Array [
systemMeaning stringnullablerequired
The type of address: 'Postal' for postal addresses, 'Home' for residential addresses, or null for other custom types.
id uuidrequired
UUID of the community member's address record
addressId uuidrequired
UUID of the record containing details for a given address (street name/number, postcode, etc)
addressType objectnullablerequired
The lookup for the address type (null if systemMeaning is not 'home' or 'postal')
id
UUID of the address type lookup
description
The address type (e.g. Alternative Home Address, Occupation Address, etc)
code
The address type code (e.g. ALT, OCC)
addressLine1 stringnullablerequired
addressLine2 stringnullablerequired
addressLine3 stringnullablerequired
suburb stringnullablerequired
Burwood East
postalCode stringnullablerequired
confidential booleannullablerequired
country objectnullablerequired
id
UUID of the country lookup
description
Country name (e.g. Australia)
code
Country code (e.g. AU)
state objectnullablerequired
id
UUID of the state lookup
description
State name (e.g. Tasmania)
code
Country code (e.g. TAS)
displayAddressComma stringrequired
The community member's full address with commas separating the fields
displayAddressFull stringrequired
The community member's full address with each field on a new line
]
homeLanguages object[]required
Array [
id uuidrequired
language objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
sortOrder integernullablerequired
]
nationalities object[]required
Array [
id uuidrequired
nationality objectnullablerequired
id uuidrequired
description stringrequired
code stringrequired
sortOrder integernullablerequired
]
occupation objectnullablerequired
company stringnullablerequired
description stringnullablerequired
industry objectnullablerequired
id stringnullablerequired
description stringnullablerequired
occupation objectnullablerequired
id stringnullablerequired
description stringnullablerequired
positionCategory objectnullablerequired
id stringnullablerequired
description stringnullablerequired
education objectrequired
education stringnullablerequired
qualifications stringnullablerequired
lastYearOfStudy integernullablerequired
highestSecondaryLevel objectnullablerequired
id stringnullablerequired
description stringnullablerequired
highestQualificationLevel objectnullablerequired
id stringnullablerequired
description stringnullablerequired
highestNonNationalQualificationLevel objectnullablerequired
id stringnullablerequired
description stringnullablerequired

Example (from schema)

{
  "code": "OK",
  "data": {
    "communityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isCompany": true,
    "schoolId": "string",
    "personalInfo": {
      "spouseCommunityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "schoolId": "string",
      "givenName": "string",
      "surname": "string",
      "prefName": "string",
      "otherGivenName": "string",
      "nameSuffix": "string",
      "overrideLegalSurname": "string",
      "overrideMailFormat": {
        "id": 0,
        "description": "string"
      },
      "overrideSalutationFormat": {
        "id": 0,
        "description": "string"
      },
      "overrideSalutationPreferredFormat": {
        "id": 0,
        "description": "string"
      },
      "familyNamePrevious": "string",
      "maidenName": "string",
      "isPrimary": true,
      "initials": "string",
      "title": {
        "id": "string",
        "description": "string"
      },
      "displayName": "string",
      "displayNameForList": "string",
      "birthDate": "2025-03-12",
      "gender": {
        "id": "string",
        "description": "string"
      },
      "deceasedDate": "2025-03-12",
      "deceased": true
    },
    "companyInfo": {
      "schoolId": "string",
      "companyName": "string",
      "companyAttention": "string"
    },
    "addressInfo": {
      "postalAddressChecked": true,
      "addresses": [
        {
          "systemMeaning": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "addressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "addressType": {},
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "suburb": "string",
          "postalCode": "string",
          "confidential": true,
          "country": {},
          "state": {},
          "displayAddressComma": "string",
          "displayAddressFull": "string"
        }
      ]
    },
    "contactDetails": {
      "deceased": true,
      "emailAddress": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "emailType": {},
          "value": "string",
          "default": true,
          "sortOrder": 0
        }
      ],
      "internetAndSocialMedia": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "websiteType": {},
          "value": "string",
          "sortOrder": 0
        }
      ],
      "phoneNumber": [
        {
          "phoneType": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "description": "string",
            "code": "string"
          },
          "value": "string",
          "confidential": true,
          "preferred": true,
          "defaultSMS": true,
          "extension": "string",
          "countryCode": "string",
          "country": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "description": "string",
            "code": "string"
          }
        }
      ]
    },
    "demographics": {
      "overrideRegion": true,
      "religion": {
        "id": "string",
        "description": "string"
      },
      "indigenousStatus": {
        "id": "string",
        "description": "string"
      },
      "parish": {
        "id": "string",
        "description": "string"
      },
      "region": {
        "id": "string",
        "description": "string"
      },
      "birthCountry": {
        "id": "string",
        "description": "string"
      },
      "addresses": [
        {
          "systemMeaning": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "addressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "addressType": {},
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "suburb": "string",
          "postalCode": "string",
          "confidential": true,
          "country": {},
          "state": {},
          "displayAddressComma": "string",
          "displayAddressFull": "string"
        }
      ],
      "homeLanguages": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "language": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "description": "string",
            "code": "string"
          },
          "sortOrder": 0
        }
      ],
      "nationalities": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "nationality": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "description": "string",
            "code": "string"
          },
          "sortOrder": 0
        }
      ]
    },
    "occupation": {
      "company": "string",
      "description": "string",
      "industry": {
        "id": "string",
        "description": "string"
      },
      "occupation": {
        "id": "string",
        "description": "string"
      },
      "positionCategory": {
        "id": "string",
        "description": "string"
      }
    },
    "education": {
      "education": "string",
      "qualifications": "string",
      "lastYearOfStudy": 0,
      "highestSecondaryLevel": {
        "id": "string",
        "description": "string"
      },
      "highestQualificationLevel": {
        "id": "string",
        "description": "string"
      },
      "highestNonNationalQualificationLevel": {
        "id": "string",
        "description": "string"
      }
    }
  }
}

Successful

{
  "code": "OK",
  "data": {
    "communityId": "d2ae2d3f-de28-4b4e-afa0-7cf284fea25d",
    "isCompany": false,
    "schoolId": "7882",
    "companyInfo": null,
    "personalInfo": {
      "spouseCommunityId": "ef1cfa9c-af9d-461d-9a62-7404633cb441",
      "givenName": "Jane",
      "surname": "Abbot",
      "prefName": "Jane",
      "otherGivenName": null,
      "nameSuffix": null,
      "overrideLegalSurname": null,
      "overrideMailFormat": null,
      "overrideSalutationFormat": null,
      "overrideSalutationPreferredFormat": null,
      "familyNamePrevious": null,
      "maidenName": null,
      "isPrimary": false,
      "initials": "JA",
      "title": {
        "id": "f54c7b12-67dd-41ba-9e2c-4261bef2bb57",
        "description": "Ms"
      },
      "displayName": "ABBOT, Ms Jane",
      "displayNameForList": "ABBOT, Jane",
      "birthDate": "1978-09-17",
      "gender": {
        "id": "f54b66eb-bcc0-48f5-99e5-21e561c1ff12",
        "description": "Female"
      },
      "deceasedDate": null,
      "deceased": false
    },
    "addressInfo": {
      "addresses": [
        {
          "systemMeaning": "home",
          "id": "24eee052-aec8-46fa-a29e-7994cbadd4fc",
          "addressId": "d19702ce-08aa-4a1a-81dd-3a931702f945",
          "addressType": null,
          "addressLine1": "123 Taradale Road",
          "addressLine2": "Apartment 4b",
          "addressLine3": "",
          "suburb": "Cranbourne North",
          "postalCode": "3977",
          "confidential": false,
          "country": {
            "id": "385df538-66fc-45b9-860c-65f01314abef",
            "description": "New Zealand",
            "code": "NZ"
          },
          "state": {
            "id": "1ec93d5d-f2ea-4aa4-8c1e-1b0eec8ad194",
            "description": "Otago",
            "code": "NZ-OTA"
          },
          "displayAddressComma": "123 Taradale Road, Apartment 4b, CRANBOURNE NORTH, NZ-OTA, 3977, New Zealand",
          "displayAddressFull": "123 Taradale Road\nApartment 4b\nCRANBOURNE NORTH\nNZ-OTA\n3977\nNew Zealand"
        }
      ],
      "postalAddressChecked": false
    },
    "contactDetails": {
      "emailAddress": [
        {
          "id": "cde10b05-8d55-4b3a-802e-b3521aa1c540",
          "emailType": {
            "id": "49d3866a-c15a-40a1-809f-7bd03362736f",
            "description": "Personal"
          },
          "value": "personal@gmail.com",
          "sortOrder": 1,
          "default": true
        }
      ],
      "internetAndSocialMedia": [
        {
          "id": "f7e62b7a-bb2c-4582-9331-46524d8f993a",
          "websiteType": {
            "id": "8c42afd1-9081-46b2-954b-2bd52d449edb",
            "description": "Facebook"
          },
          "value": "www.facebook.com/myprofileurl",
          "sortOrder": 1
        },
        {
          "id": "fbaaa918-3180-4259-b0c1-af5c1a29995a",
          "websiteType": {
            "id": "c72569ae-83e4-4da7-a86c-c4269727f0d1",
            "description": "LinkedIn"
          },
          "value": "www.linkedin.com/in/thisismyprofile",
          "sortOrder": 4
        }
      ],
      "phoneNumber": [
        {
          "id": "ec17d7c5-c21d-40a9-a7c5-4c65ef4bc749",
          "phoneType": {
            "id": "98c06b1f-c7d6-43e4-8f01-2311000bf679",
            "description": "Personal mobile",
            "code": "PERSONALMOBILE"
          },
          "value": "0412345678",
          "confidential": false,
          "countryCode": "AU +61",
          "country": {
            "id": "283a7817-5c27-48bb-9650-4ccfa11a3704",
            "description": "Australia",
            "code": "AU"
          },
          "preferred": true,
          "defaultSMS": true,
          "extension": null,
          "sortOrder": 1
        }
      ],
      "deceased": false
    },
    "demographics": {
      "overrideRegion": true,
      "religion": {
        "id": "25625dec-85cc-45c3-a7e6-2b0f717f4c86",
        "description": "Anglican Church of Australia"
      },
      "indigenousStatus": null,
      "parish": {
        "id": "c28c85a1-e347-4865-b86b-1af5d16352b5",
        "description": "Alexandra"
      },
      "region": {
        "id": "24ee6291-2434-488a-853e-746d59527a7d",
        "description": "Region 2"
      },
      "birthCountry": {
        "id": "1b4379ee-ec7d-408f-bee1-ad2d02568419",
        "description": "Afghanistan"
      },
      "addresses": [
        {
          "systemMeaning": "home",
          "id": "24eee052-aec8-46fa-a29e-7994cbadd4fc",
          "addressId": "d19702ce-08aa-4a1a-81dd-3a931702f945",
          "addressType": null,
          "addressLine1": "123 Taradale Road",
          "addressLine2": "Apartment 4b",
          "addressLine3": "",
          "suburb": "Cranbourne North",
          "postalCode": "3977",
          "confidential": false,
          "country": {
            "id": "385df538-66fc-45b9-860c-65f01314abef",
            "description": "New Zealand",
            "code": "NZ"
          },
          "state": {
            "id": "1ec93d5d-f2ea-4aa4-8c1e-1b0eec8ad194",
            "description": "Otago",
            "code": "NZ-OTA"
          },
          "displayAddressComma": "123 Taradale Road, Apartment 4b, CRANBOURNE NORTH, NZ-OTA, 3977, New Zealand",
          "displayAddressFull": "123 Taradale Road\nApartment 4b\nCRANBOURNE NORTH\nNZ-OTA\n3977\nNew Zealand"
        }
      ],
      "homeLanguages": [
        {
          "id": "2dfe62c6-e68d-44f9-9657-97f91916b867",
          "language": {
            "id": "64a48038-517f-4f28-a057-f971bdb7b3dc",
            "description": "Welsh",
            "code": "1063"
          },
          "sortOrder": null
        }
      ],
      "nationalities": [
        {
          "id": "c811a5c6-b169-419a-84ee-19f9c239fded",
          "nationality": {
            "id": "60e38915-0850-4af7-96b9-e564b8abea9a",
            "description": "American",
            "code": "US"
          },
          "sortOrder": null
        }
      ]
    },
    "occupation": {
      "company": "123 XYZ",
      "description": "Description here",
      "industry": {
        "id": "6af8cec7-40d9-40db-8994-bfaa9e71ba26",
        "description": "Poultry Farming"
      },
      "occupation": {
        "id": "9d40c471-4450-4fd9-9c58-d3df875cdc04",
        "description": "Mechanic"
      },
      "positionCategory": {
        "id": "7c2b1fb6-8839-40a4-b68f-8f9bf151d050",
        "description": "Not stated or unknown"
      }
    },
    "education": {
      "education": "Education details here",
      "qualifications": null,
      "lastYearOfStudy": 2000,
      "highestSecondaryLevel": {
        "id": "534f57f5-e8e1-4454-a6cc-7a986513b47e",
        "description": "Year 12 or below"
      },
      "highestQualificationLevel": {
        "id": "c5153bde-3e13-43ca-98be-f26d3f622383",
        "description": "Certificate I to IV (including trade certificate)"
      },
      "highestNonNationalQualificationLevel": {
        "id": "00f07498-6fb7-4570-a45e-d34b333859a2",
        "description": "International Baccalaureate (prep year) Year 11"
      }
    }
  }
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1100",
      "message": "Bad Request"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1101",
      "message": "Unauthorized"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1102",
      "message": "Forbidden"
    }
  ]
}

404

Resource not found

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1103",
      "message": "Not Found"
    }
  ]
}

422

Unprocessable entity

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1108",
      "message": "Unprocessable Entity"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1109",
      "message": "Internal Server Error"
    }
  ]
}

Loading...