Partner API Retrieval
Introduction
Our API provides a realtime look into leads on our digital platform. As soon as a user opts into a partners offer, the user will be available for consumption.
The base url for all production API calls is:
https://leads.mymove.com
For staging leads:
https://staging-leads.mymove.com
Authentication
We require all calls to the API be authorized with an access token. Please contact your MYMOVE representative in order to obtain an API key. We will also send your client ID to use with the Find all leads endpoint.
It is imperative that this API key be kept secret and never revealed publically or shared via plaintext in emails or chat applications. Please treat this as you would treat the password to your bank account.
Headers
Header | Value |
---|---|
Authorization | your secret access token |
Content-Type | application/json |
Endpoints
Find all leads
GET /v2/clients/:clientID/leads
Query Parameters
This endpoint supports a few query parameters in order to filter results:
days
will filter the results to leads created between now anddays
ago. If you pass,days=5
we will return all leads from now to 5 days ago.hrs
works in a similar fashion.days=1
is the same ashrs=24
.alternatively, you can pass both the
start
and theend
parameters with a time formatted to the RFC3339 standard. For example,start=2020-01-01T14:30:00Z
andend=2020-01-01T15:00:00Z
will pass all leads from between Jan 1 2020 at 2:30PM UTC and Jan 1 2020 at 3:00PM UTC.
Parameter | Type |
---|---|
days | int |
hrs | int |
start | time RFC3339 |
end | time RFC3339 |
Response
{
"leads": [
{
"offer_id": "10000",
"created_at": "2017-10-04T15:49:54Z",
"first_name": "John",
"last_name": "Smith",
"email": "js@atestemail.com",
"move_date": "2017-10-04T00:00:00Z",
"new_housing_tenure": "own",
"new_address_1": "123 Main St.",
"new_address_2": "Apt. 1",
"new_city": "Charlotte",
"new_state": "NC",
"new_postal_code": "28203",
"new_postal_code_plus4": "0000"
}
]
}
Example in Golang
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://leads.mymove.com/v2/clients/00000000-aaaa-bbbb-cccc-eeeeffff1111/leads?hrs=1"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("content-type", "application/json")
req.Header.Add("authorization", "your-api-key")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(string(body))
}