YourNextHome
API ReferenceInquiry

Get inquiries

GET
/api/v1/inquiry

Query Parameters

estateId?string

The estate ID to filter inquiries by

offset?number

The offset to start returning inquiries from

limit?number

The number of inquiries to return

Response Body

application/json

curl -X GET "https://example.com/api/v1/inquiry"
{
  "count": 0,
  "items": [
    {
      "id": "b6c6b5b6-7b1d-4b8f-8f5e-5e8f4b1d7b6b",
      "name": "John Doe",
      "email": "example@email.com",
      "referralUserId": "b6c6b5b6-7b1d-4b8f-8f5e-5e8f4b1d7b6b",
      "referralUser": {
        "id": "string",
        "firstName": "string",
        "lastName": "string",
        "avatarUrl": "string",
        "jobTitle": "string",
        "description": "string",
        "email": "string",
        "role": "admin",
        "createdAt": "2019-08-24T14:15:22Z",
        "isRegistered": true,
        "organizationMemberships": [
          {
            "id": "string",
            "userId": "string",
            "organizationId": "string",
            "organization": {
              "id": "string",
              "name": "string",
              "featureFlags": [
                "estates"
              ]
            },
            "role": "string",
            "createdAt": "2019-08-24T14:15:22Z"
          }
        ]
      },
      "estateId": "b6c6b5b6-7b1d-4b8f-8f5e-5e8f4b1d7b6b",
      "apartmentIds": [
        "b6c6b5b6-7b1d-4b8f-8f5e-5e8f4b1d7b6b"
      ],
      "status": "NEW",
      "phoneNumber": "0123456789",
      "info": "Some additional info",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "updatedAt": "2022-01-01T00:00:00.000Z"
    }
  ]
}