# Get home value alert

**GET /home-value-alerts/{id}**

One home value alert: who it is for, the home it values, any valuation the agent gave, how often it sends, and whether it is paused.

Requires the `home_value_alerts:read` scope. Rate budget: 300 calls per 1 minute per credential (the `read` class).


## Servers
- https://www.realscout.com/api/agent/v1: https://www.realscout.com/api/agent/v1 ()


## Authentication methods
- Bearer auth


## Parameters

### Path parameters

- **id** (string)
  The home value alert id.




## Responses
### 200
OK
#### Headers

- **X-RateLimit-Limit** (integer)
  Calls allowed in the current window.

- **X-RateLimit-Remaining** (integer)
  Calls left in the current window.

- **X-RateLimit-Reset** (integer)
  Epoch seconds at which the window resets.


#### Body: application/json (object)
- **id** (string)

- **contact** (object | null)

- **address** (string | null)

- **city** (string | null)

- **state** (string | null)

- **zipcode** (string | null)

- **agent_valuation** (integer | null)

- **agent_value_low** (integer | null)

- **agent_value_high** (integer | null)

- **agent_valuation_updated_at** (string(date-time) | null)

- **schedule** (string | null)

- **disabled** (boolean | null)

- **last_sent_at** (string(date-time) | null)

- **next_send_at** (string(date-time) | null)

- **created_at** (string(date-time) | null)

- **updated_at** (string(date-time) | null)

- **realscout_url** (string(uri) | null)


### 400
The request is invalid; `field` names the offending input when there is one. A body that is not valid JSON is refused before the API runs, as a bare 400 with no body.

#### Body: application/json (object)
- **error** (object)


### 401
Invalid or missing bearer token.

#### Body: application/json (object)
- **error** (object)


### 403
The credential was not granted the scope this call requires.

#### Body: application/json (object)
- **error** (object)


### 404
Not found, or not yours: the two are indistinguishable on purpose.

#### Body: application/json (object)
- **error** (object)


### 429
Rate limit exceeded; `Retry-After` says when to try again.
#### Headers

- **Retry-After** (integer)
  Seconds until the budget refills.


#### Body: application/json (object)
- **error** (object)


### 500
Something went wrong on our side.

#### Body: application/json (object)
- **error** (object)



[Powered by Bump.sh](https://bump.sh)