Manage agents for your company. In the Spectora data model, an agent record is referred to as a 'connection' — it represents the link between a real estate agent and your company. The API routes and field names use 'connection' terminology, but conceptually these are your agents.
List agents
Returns a paginated list of agents for your company. In Spectora's data model, an agent record is called a 'connection' — it represents the link between a real estate agent and your company. The API routes and field names use 'connection' terminology, but conceptually these are your agents. Supports filtering by agency, agent team, email, tags, and full-text search. Results can be sorted by name, agency, team, and inspection counts.
query Parameters
includeComma-separated list of relationships to include in the response. Available relationships: agent, agent_team.
page[number]Page number (starts at 1)
page[size]Number of records per page (default: 200, max: 200)
filter[id]Filter by agent ID (the connection ID for this agent in your company)
filter[agency_id]Filter by agency ID
filter[agent_id]Filter by the agent's global ID (shared across companies)
filter[agent_team_id]Filter by agent team ID
filter[email]Filter by exact email address
filter[fulltext]Full-text search across agent name, agency name, agent team name, and user details
filter[tag]Filter by tag name(s). Can be a single tag or an array of tags.
sortSort field. Prefix with '-' for descending order. Available fields: agency_name, agent_inspections, agent_team_name, buying_agent_inspections, first_name, last_name, last_first_name, selling_agent_inspections
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List agents › Responses
Agents retrieved successfully
Pagination metadata
Pagination links
Create an agent
Creates a new agent for your company. In Spectora's data model, an agent record is called a 'connection' — it represents the link between a real estate agent and your company. The request body uses 'connection' field names.
When including an image change the body to Multipart and pass data in key value entries with the key formatted as data[attributes][field-name]. For the images specifically use data[attributes][image] and include the image file as the value. Supported image file types are: .jpg, .jpeg, .png, and .gif.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Content-TypeCreate an agent › Responses
Agent created successfully
Get an agent
Returns detailed information about a specific agent, including contact details, social media links, tags, and inspection statistics. In Spectora's data model, an agent record is called a 'connection'. The {id} path parameter is the connection ID for this agent in your company.
path Parameters
idAgent ID (the connection ID for this agent in your company)
query Parameters
includeComma-separated list of relationships to include in the response. Available relationships: agent, agent_team.
optional_fieldsComma-separated list of additional computed fields to include in the response. Available fields: date_of_first_inspection.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get an agent › Responses
Agent retrieved successfully
Update an agent
Updates an existing agent. All fields are optional — only provided fields will be updated. Note: the agent's email cannot be changed via this endpoint. In Spectora's data model, an agent record is called a 'connection'. The {id} path parameter is the connection ID for this agent in your company.
When including an image change the body to Multipart and pass data in key value entries with the key formatted as data[attributes][field-name]. For the images specifically use data[attributes][image] and include the image file as the value. Supported image file types are: .jpg, .jpeg, .png, and .gif.
path Parameters
idAgent ID (the connection ID for this agent in your company)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Content-TypeUpdate an agent › Responses
Agent updated successfully