Available Methods

Retrieve an Agent

POST https://www.relahq.com/api/v1/object/agent_card/[nid]

Path Parameters

Name	Type	Description
nid*	String	The Rela defined id representing the object

Headers

Name	Type	Description
TOKEN*		Your API Token
API-KEY*		Your API Key
content-type*	String	application/json

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
  "id": "123456",
  "name": "John Doet",
  "agent_first_name": "John",
  "agent_last_name": "Doe",
  "email": "[e-mail]",
  "phone": "703-555-5555",
  "company": "Acme Co",
  "professional_title": "Associate Broker",
  "license": null,
  "website": "https://www.example.com/",
  "social_media_links": [
    {
      "service": "facebook",
      "url": "https://www.facebook.com/johndoe",
      "weight": "-10"
    },
    {
      "service": "linkedin",
      "url": "https://www.linkedin.com/in/john-doet/",
      "weight": "-9"
    }
  ],
  "card_type": "agency_card",
  "agency_profile": "1234456",
  "headshot_url": "https://example.com/edgossett.jpg",
  "notes": null
}

Create an Agent

POST https://www.relahq.com/api/v1/object/agent_card/

Headers

Name	Type	Description
TOKEN*		Your API Token
API-KEY*		Your API Key
content-type*	String	application/json

Request Body

Name	Type	Description
headshot	Array	File or URL
name*	String	The agent’s name
phone	String	The agent’s phone number
email*	String	The agent’s email address
company*	String	The agent’s company
license	String	The agent’s license number
website	String	The agent’s website

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
  "nid": "1234",
}

Update an Agent

PUT https://www.relahq.com/api/v1/object/agent_card/[nid]

Example request for updating name and website.

Path Parameters

Name	Type	Description
nid*	String	The Rela defined id representing the object

Headers

Name	Type	Description
content-type*	String	application/json
API-KEY*	String	Your API Key
TOKEN*	String	Your API Token

Request Body

Name	Type	Description
website	String	The agent’s website
name*	String	The agent’s name

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
    "nid": "1234",
}

Delete an Agent

DELETE https://www.relahq.com/api/v1/object/agent_card/[nid]

Path Parameters

Name	Type	Description
nid*	String	The Rela defined id representing the object

Headers

Name	Type	Description
TOKEN*		Your API Token
API-KEY*		Your API Key
content-type*	String	application/json

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
    [true],
}

Get all Agents

GET https://www.relahq.com /api/v1/object/agent_cards

Headers

Name	Type	Description
API-KEY*	String	Your API Key
TOKEN*	String	Your API Token
content-type*	String	application/json

200: OK Success

HTTP/1.1 200 OK 
#Example Response
{
 '{1234: {"email": "[e-mail]", "nid": "1234"},
   5678: {"email": "[e-mail]", "nid": "5678"},
   9012: {"email": "[e-mail]", "nid": "9012"}
 }' 
}

Error Values:

Not Enough Agent Seats - Account has hit limit on agent seats. Purchase additional seats to add a new agent.

Agent Already Exists - Error will be returned if attempting to create an agent account with an email that already exists for an agent in Rela.