Get all residents

GET 
/residents

Get all residents

Responses

200

OK

application/json

Schema

Schema

data

object[]

Array [

access string

building string

created_at string

deleted_at string

displayName string

email string

firstName string

id string

jobTitle string

lastName string

middleInitial string

name string

phone string

resEmail string

resNameFirst string

token?: string; phoneNumber?: string; roomNumber?: string; secondaryPhone?: string; mainPhone?: string; careType?: Array; initials?: string; uid?: string; companyId?: string; currentActiveCommunity?: string; communityAccessList?: Array; communityId?: string; lastModified?: Timestamp | ""; lastLogin?: Timestamp | ""; relationshipToResident?: string; statePermissions?: StatePermissionsEnum; powerOfAttorney?: string; signature?: string; status?: StatusEnum; residentExternalId?: string; matrixResId?: string; welcomeHomeResId?: string; totangoId?: string; linked?: boolean;

resNameFull string

unit string

updated_at string

]

message string
success boolean

Example (from schema)

{
  "data": [
    {
      "access": "string",
      "building": "string",
      "created_at": "string",
      "deleted_at": "string",
      "displayName": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "jobTitle": "string",
      "lastName": "string",
      "middleInitial": "string",
      "name": "string",
      "phone": "string",
      "resEmail": "string",
      "resNameFirst": "string",
      "resNameFull": "string",
      "unit": "string",
      "updated_at": "string"
    }
  ],
  "message": "string",
  "success": true
}

Loading...