### Get Listing Report Signup Requests

Source: https://www.idxhome.com/api/v1/docs/ListingReportSignupRequests.html

Retrieves a list of listing report signup requests. Supports pagination and provides total counts, links, and error information.

```APIDOC
## GET /websites/idxhome_api_v1/listing_report_signup_requests

### Description
Retrieves a list of listing report signup requests.

### Method
GET

### Endpoint
/websites/idxhome_api_v1/listing_report_signup_requests

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return.
- **offset** (integer) - Optional - The number of results to skip.

### Response
#### Success Response (200)
- **results** (ListingReportSignupRequest[]) - An array of listing report signup request objects.
- **total** (integer) - The total number of results without considering limit and offset.
- **links** (Link[]) - An array of link objects.
- **errors** (Error[]) - An array of error objects.
```

--------------------------------

### Get Schedule Showing Requests

Source: https://www.idxhome.com/api/v1/docs/ScheduleShowingRequests.html

Retrieves a list of schedule showing requests. Supports pagination and filtering through query parameters.

```APIDOC
## GET /websites/idxhome_api_v1/scheduleShowingRequests

### Description
Retrieves a list of schedule showing requests. This endpoint returns an array of ScheduleShowingRequest objects, along with pagination information and potential errors.

### Method
GET

### Endpoint
/websites/idxhome_api_v1/scheduleShowingRequests

### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return.
- **offset** (integer) - Optional - The number of results to skip before starting to collect the result set.

### Response
#### Success Response (200)
- **results** (ScheduleShowingRequest[]) - An array of schedule showing request objects.
- **total** (integer) - The total number of results available without considering limit and offset.
- **links** (Link[]) - An array of link objects for pagination or related resources.
- **errors** (Error[]) - An array of error objects if any occurred during the request.

#### Response Example
```json
{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "propertyId": "prop-abc",
      "showingId": "showing-xyz",
      "requestorName": "John Doe",
      "requestorEmail": "john.doe@example.com",
      "requestorPhone": "555-123-4567",
      "status": "Approved",
      "requestedDateTime": "2023-10-27T10:00:00Z",
      "createdAt": "2023-10-26T15:30:00Z",
      "updatedAt": "2023-10-27T09:00:00Z"
    }
  ],
  "total": 100,
  "links": [
    {
      "rel": "next",
      "href": "/websites/idxhome_api_v1/scheduleShowingRequests?limit=10&offset=10"
    }
  ],
  "errors": []
}
```
```

--------------------------------

### ClientBoard Response Structure

Source: https://www.idxhome.com/api/v1/docs/ClientBoards.html

This details the structure of the response when querying client boards. It includes an array of client board results, the total number of results, pagination links, and any errors encountered.

```APIDOC
## ClientBoard Response

### Description
This object represents the response structure for client board related queries.

### Fields
- **results** (ClientBoard[]) - Required - An array of client board objects.
- **total** (Integer) - Required - The total number of results available without considering limit and offset.
- **links** (Link[]) - Required - An array of link objects for pagination and related resources.
- **errors** (Error[]) - Required - An array of error objects if any occurred during the request.
```

--------------------------------

### List Listing Photos

Source: https://www.idxhome.com/api/v1/docs/ListingPhotos.html

Retrieves a list of listing photos. Supports pagination and returns total counts, links, and errors.

```APIDOC
## GET /listings/photos

### Description
Retrieves a list of listing photos with pagination details.

### Method
GET

### Endpoint
/listings/photos

### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return.
- **offset** (integer) - Optional - The number of results to skip.

### Response
#### Success Response (200)
- **results** (ListingPhoto[]) - An array of listing photo objects.
- **total** (integer) - The total number of results available without considering limit and offset.
- **links** (Link[]) - An array of link objects for pagination.
- **errors** (Error[]) - An array of error objects if any occurred during the request.
```

--------------------------------

### EmailUpdateSignupRequests Response Structure

Source: https://www.idxhome.com/api/v1/docs/EmailUpdateSignupRequests.html

This snippet details the fields returned in a response for email update signup requests.

```APIDOC
## EmailUpdateSignupRequests

### Description
This endpoint returns a list of email update signup requests along with pagination information and potential errors.

### Response
#### Success Response (200)
- **results** (EmailUpdateSignupRequest[]) - An array of email update signup request objects.
- **total** (Integer) - The total number of results available without considering limit and offset.
- **links** (Link[]) - An array of link objects for pagination.
- **errors** (Error[]) - An array of error objects if any occurred during the request.
```

--------------------------------

### Subscriber Response Structure

Source: https://www.idxhome.com/api/v1/docs/Subscribers.html

Details the fields returned in a subscriber-related API response.

```APIDOC
## Subscriber Response

### Description
This section details the fields returned in a typical subscriber API response.

### Fields
- **results** (Subscriber[]) - An array of subscriber objects.
- **total** (Integer) - The total number of results available without considering limit and offset.
- **links** (Link[]) - An array of link objects, typically for pagination.
- **errors** (Error[]) - An array of error objects, if any occurred during the request.
```

--------------------------------

### ContactRequest Response Structure

Source: https://www.idxhome.com/api/v1/docs/ContactRequests.html

This details the structure of the response when retrieving contact requests. It includes an array of ContactRequest objects, the total number of results, pagination links, and any errors encountered.

```APIDOC
## Contact Requests Response

### Description
This object represents the response structure for retrieving contact requests.

### Fields
- **results** (ContactRequest[]) - An array of contact request objects.
- **total** (Integer) - The total number of results available without considering limit and offset.
- **links** (Link[]) - An array of link objects for pagination.
- **errors** (Error[]) - An array of error objects, if any occurred during the request.
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.