Spectora Public API

Connections

Endpointhttps://connect-staging.spectora.com

Create a connection

POST

https://connect-staging.spectora.com

/v2/connections

Creates a new connection (agent) for your company. A connection represents a real estate agent or other professional associated with your inspections.

Create a connection › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Content-Type

string

Default: application/json

Create a connection › Request Body

object · required

Create a connection › Responses

Connection created successfully

object · required

POST/v2/connections

curl --request POST \
  --url https://connect-staging.spectora.com/v2/connections \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "attributes": {
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "[email protected]",
      "phone": "(555) 123-4567",
      "mobile_phone": "(555) 987-6543",
      "home_phone": "home_phone",
      "second_phone": "second_phone",
      "address": "123 Main Street",
      "city": "Austin",
      "state": "TX",
      "zip": "78701",
      "agency_name": "Premier Realty",
      "agency_phone": "agency_phone",
      "cc_email": "cc_email",
      "notes": "notes",
      "private_notes": "private_notes",
      "birthday_month": 6,
      "birthday_day": 15,
      "facebook_link": "https://facebook.com/janesmith",
      "linkedin_link": "https://linkedin.com/in/janesmith",
      "twitter_link": "twitter_link",
      "instagram_link": "instagram_link",
      "tiktok_link": "tiktok_link",
      "website": "https://janesmithrealty.com",
      "tag_list": [
        "string"
      ],
      "not_show_recommended_contractors_on_reports": true,
      "image": "image"
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "attributes": {
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "[email protected]",
      "phone": "(555) 123-4567",
      "mobile_phone": "(555) 987-6543",
      "home_phone": "home_phone",
      "second_phone": "second_phone",
      "address": "123 Main Street",
      "city": "Austin",
      "state": "TX",
      "zip": "78701",
      "agency_name": "Premier Realty",
      "agency_phone": "agency_phone",
      "cc_email": "cc_email",
      "notes": "notes",
      "private_notes": "private_notes",
      "birthday_month": 6,
      "birthday_day": 15,
      "facebook_link": "https://facebook.com/janesmith",
      "linkedin_link": "https://linkedin.com/in/janesmith",
      "twitter_link": "twitter_link",
      "instagram_link": "instagram_link",
      "tiktok_link": "tiktok_link",
      "website": "https://janesmithrealty.com",
      "tag_list": [
        "string"
      ],
      "not_show_recommended_contractors_on_reports": true,
      "image": "image"
    }
  }
}

json

Example Responses

{
  "data": {
    "id": "12345",
    "type": "connection",
    "attributes": {
      "agent_id": 0,
      "agent_uuid": {},
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "[email protected]",
      "phone": {},
      "second_phone": {},
      "address": {},
      "full_address": "full_address",
      "city": {},
      "state": {},
      "country": {},
      "zip": {},
      "agency_id": {},
      "agency_name": {},
      "agency_phone": {},
      "agent_team_id": {},
      "company_id": 0,
      "uuid": "uuid",
      "cc_email": "cc_email",
      "notes": "notes",
      "private_notes": {},
      "birthday_month": {},
      "birthday_day": {},
      "facebook_link": {},
      "linkedin_link": {},
      "twitter_link": {},
      "instagram_link": {},
      "tiktok_link": {},
      "website": {},
      "image": "image",
      "thumb": "thumb",
      "tag_list": [
        "string"
      ],
      "tags": [
        {
          "id": 0,
          "company_id": 0,
          "name": "name",
          "color": "#5c9ccf",
          "created_at": "2024-08-25T15:00:00Z",
          "updated_at": "2024-08-25T15:00:00Z",
          "auto_tagging_rule": {},
          "auto_tagging_enabled": true,
          "auto_tagging_remove_on_fail": true,
          "auto_tagging_person": "auto_tagging_person"
        }
      ],
      "notes_ids": [
        0
      ],
      "buying_agent_inspections": 0,
      "selling_agent_inspections": 0,
      "total_inspections_count": 0,
      "not_show_recommended_contractors_on_reports": true
    },
    "relationships": {
      "agent": {
        "data": {
          "id": "id",
          "type": "agent"
        }
      },
      "agent_team": {
        "data": {}
      }
    }
  }
}

json

application/json

Create a connection

POST

https://connect-staging.spectora.com

/v2/connections

Creates a new connection (agent) for your company. A connection represents a real estate agent or other professional associated with your inspections.

Create a connection › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Content-Type

string

Default: application/json

Create a connection › Request Body

object · required

Create a connection › Responses

Connection created successfully

object · required

curl --request POST \ --url https://connect-staging.spectora.com/v2/connections \ --header 'Authorization: <string>' \ --header 'Content-Type: application/json' \ --data ' { "data": { "attributes": { "first_name": "Jane", "last_name": "Smith", "email": "[email protected]", "phone": "(555) 123-4567", "mobile_phone": "(555) 987-6543", "home_phone": "home_phone", "second_phone": "second_phone", "address": "123 Main Street", "city": "Austin", "state": "TX", "zip": "78701", "agency_name": "Premier Realty", "agency_phone": "agency_phone", "cc_email": "cc_email", "notes": "notes", "private_notes": "private_notes", "birthday_month": 6, "birthday_day": 15, "facebook_link": "https://facebook.com/janesmith", "linkedin_link": "https://linkedin.com/in/janesmith", "twitter_link": "twitter_link", "instagram_link": "instagram_link", "tiktok_link": "tiktok_link", "website": "https://janesmithrealty.com", "tag_list": [ "string" ], "not_show_recommended_contractors_on_reports": true, "image": "image" } } } '

{ "data": { "attributes": { "first_name": "Jane", "last_name": "Smith", "email": "[email protected]", "phone": "(555) 123-4567", "mobile_phone": "(555) 987-6543", "home_phone": "home_phone", "second_phone": "second_phone", "address": "123 Main Street", "city": "Austin", "state": "TX", "zip": "78701", "agency_name": "Premier Realty", "agency_phone": "agency_phone", "cc_email": "cc_email", "notes": "notes", "private_notes": "private_notes", "birthday_month": 6, "birthday_day": 15, "facebook_link": "https://facebook.com/janesmith", "linkedin_link": "https://linkedin.com/in/janesmith", "twitter_link": "twitter_link", "instagram_link": "instagram_link", "tiktok_link": "tiktok_link", "website": "https://janesmithrealty.com", "tag_list": [ "string" ], "not_show_recommended_contractors_on_reports": true, "image": "image" } } }

{ "data": { "id": "12345", "type": "connection", "attributes": { "agent_id": 0, "agent_uuid": {}, "first_name": "Jane", "last_name": "Smith", "email": "[email protected]", "phone": {}, "second_phone": {}, "address": {}, "full_address": "full_address", "city": {}, "state": {}, "country": {}, "zip": {}, "agency_id": {}, "agency_name": {}, "agency_phone": {}, "agent_team_id": {}, "company_id": 0, "uuid": "uuid", "cc_email": "cc_email", "notes": "notes", "private_notes": {}, "birthday_month": {}, "birthday_day": {}, "facebook_link": {}, "linkedin_link": {}, "twitter_link": {}, "instagram_link": {}, "tiktok_link": {}, "website": {}, "image": "image", "thumb": "thumb", "tag_list": [ "string" ], "tags": [ { "id": 0, "company_id": 0, "name": "name", "color": "#5c9ccf", "created_at": "2024-08-25T15:00:00Z", "updated_at": "2024-08-25T15:00:00Z", "auto_tagging_rule": {}, "auto_tagging_enabled": true, "auto_tagging_remove_on_fail": true, "auto_tagging_person": "auto_tagging_person" } ], "notes_ids": [ 0 ], "buying_agent_inspections": 0, "selling_agent_inspections": 0, "total_inspections_count": 0, "not_show_recommended_contractors_on_reports": true }, "relationships": { "agent": { "data": { "id": "id", "type": "agent" } }, "agent_team": { "data": {} } } } }