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 API calls is:

https://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.

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 /v1/clients/:clientID/leads

clientID: you will receive this clientID along with your API key. It is used to uniquely identify your business.

Substitute in your clientID in the above URL along with the required Headers to make a successful call.

Query Parameters

This endpoint supports a few query parameters in order to filter results. days will filter the results to leads created between now and days 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 as hrs=24.

Parameter	Type
days	int
hrs	int

Response

{
    "leads": [
        {
            "created_at": "2017-10-04T15:49:54Z",
            "email": "js@gmail.com",
            "first_name": "John",
            "last_name": "Smith",
            "move_date": "2017-10-04T00:00:00Z",
            "new_address_line_1": "123 Main St.",
            "new_address_line_2": "Apt. 1",
            "new_address_city": "Charlotte",
            "new_address_housing_tenure": "own",
            "new_address_state": "NC",
            "new_address_postal_code": "28203",
            "new_address_postal_code_plus4": "0000"
        }
    ]
}

Example in Golang

package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {

    url := "https://leads.mymove.com/v1/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))
}

V1