Spectora Public API

Inspections

Endpointhttps://connect-dev.spectora.com

List inspections

GET

https://connect-dev.spectora.com

/v2/inspections

Returns a paginated list of inspections for your company. Supports filtering by date range, status, agents, inspectors, services, property location, and more. Results can be sorted by datetime, quote, confirmed, and cancel reason. By default, canceled, deleted, and archived inspections are excluded.

List inspections › query Parameters

include

string

Comma-separated list of relationships to include in the response. Available relationships: assignments, buyer, buyer_2, buying_agent, company, custom_fields, inspection_attachments, property, selling_agent.

fields[inspection]

string

Comma-separated list of specific fields to include in the response. Example: slug,datetime,quote,buyer_name

page[number]

integer

Page number (starts at 1)

page[size]

integer

Number of records per page (default: 200, max: 200)

filter[id]

string

Filter by inspection ID or slug

filter[connection_id]

integer

Filter by connection ID (matches buying agent or selling agent connections)

filter[fulltext]

string

Full-text search across inspection data (buyer name, address, agent name, etc.)

filter[datetime_greater_than]

string · date-time

Only include inspections with a date/time on or after this value. Can be used alone or combined with filter[datetime_less_than] for a date range. ISO 8601 format (e.g., '2024-01-01T00:00:00Z').

filter[datetime_less_than]

string · date-time

Only include inspections with a date/time on or before this value. Can be used alone or combined with filter[datetime_greater_than] for a date range. ISO 8601 format (e.g., '2024-12-31T23:59:59Z').

filter[paid]

boolean

Filter by payment status (true = paid, false = unpaid)

filter[agreements_signed]

boolean

Filter by whether agreements have been signed

filter[confirmed]

boolean

Filter by confirmation status

filter[canceled]

boolean

Filter by cancellation status. By default, canceled inspections are excluded. Set to true to show only canceled inspections.

filter[archived_by_inspector]

boolean

Filter by archived status. By default, archived inspections are excluded.

filter[inspector_id]

integer[]

Filter by inspector profile ID(s). Can be a single ID or an array of IDs.

filter[service_id]

integer[]

Filter by service ID(s). Returns inspections that include any of the specified services.

filter[service_category_id]

integer[]

Filter by service category ID(s). Returns inspections with services or add-ons in the specified categories.

filter[service_add_on_id]

integer[]

Filter by service add-on ID(s). Returns inspections that include any of the specified add-ons.

filter[deleted]

boolean

Filter by deletion status. By default, deleted inspections are excluded. Set to true to show only deleted inspections.

filter[published]

boolean

Filter by publication status (true = published, false = unpublished)

filter[include_canceled]

boolean

When true, includes canceled inspections in results (overrides default exclusion)

filter[include_archived_by_inspector]

boolean

When true, includes archived inspections in results (overrides default exclusion)

filter[include_deleted]

boolean

When true, includes soft-deleted inspections in results (overrides default exclusion)

filter[address]

string

Filter by property street address (case-insensitive, exact match)

filter[zip]

string

Filter by property ZIP/postal code (exact match)

filter[unit]

string

Filter by property unit number (exact match)

filter[lat]

number

Filter by property latitude (exact match, rounded to 6 decimal places)

filter[lng]

number

Filter by property longitude (exact match, rounded to 6 decimal places)

sort

string

Sort field. Prefix with '-' for descending order. Available fields: datetime, quote, confirmed, cancel_reason

List inspections › 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.

List inspections › Responses

Inspections retrieved successfully

object[] · required

object

Pagination metadata

object

Pagination links

GET/v2/inspections

curl --request GET \
  --url https://connect-dev.spectora.com/v2/inspections \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": [
    {
      "id": "12345",
      "type": "inspection",
      "attributes": {
        "slug": "4cc49466-9036-4ebf-9a0c-2249c53ab7f7",
        "datetime": "2024-03-15T14:30:00Z",
        "duration": 2.5,
        "paid": true,
        "order_id": "ORD-2024-001",
        "description": "Standard home inspection",
        "agreements_present": true,
        "agreements_signed": true,
        "notes": "Client requested focus on foundation",
        "request_notes": "Urgent - closing in 3 days",
        "published_at": "2024-03-16T10:00:00Z",
        "created_at": "2024-03-01T09:00:00Z",
        "updated_at": "2024-03-15T16:30:00Z",
        "cover_photo_url": "https://example.com/photos/cover.jpg",
        "cover_photo_thumb_url": "https://example.com/photos/cover_thumb.jpg",
        "archived_by_inspector": false,
        "deleted_at": null,
        "confirmed": true,
        "canceled_at": null,
        "datetime_formatted": "Friday, March 15, 2024 at 2:30 PM",
        "buyer_name": "John Doe",
        "full_address": "123 Main Street, Austin, TX 78701",
        "property_address": "123 Main Street",
        "property_address_2": "Unit 4B",
        "image_url": "https://example.com/properties/image.jpg",
        "quote": "450.0",
        "buying_agent_name": "Jane Smith",
        "selling_agent_name": "Bob Johnson",
        "buying_agent_email": "[email protected]",
        "buying_agent_phone": "(555) 123-4567",
        "selling_agent_email": "[email protected]",
        "selling_agent_phone": "(555) 987-6543",
        "inspector_name": "Mike Patterson",
        "buying_agent_id": 456,
        "selling_agent_id": 789,
        "service_names": "Home Inspection, Radon Testing",
        "service_add_on_names": "Thermal Imaging, Pool Inspection",
        "buyer_names": "John Doe & Jane Doe",
        "cancel_reason": "Client postponed closing date",
        "isn_id": "ISN123456",
        "payment_method_provided": true,
        "pay_at_close_display_status": "pending",
        "is_client_complete": true,
        "tooltip": "Home inspection at 123 Main St",
        "settings": {
          "source_report_view_slug": "source_report_view_slug",
          "source_inspection_copy_reports": true,
          "build_as_firestore": true,
          "enable_auto_tracks": true
        },
        "charge_at_formatted": "03/15/2024  2:30 pm",
        "referral_source": "Internet Search",
        "discount_code": "SUMMER20"
      },
      "relationships": {
        "buyer": {
          "data": {
            "id": "id",
            "type": "buyer"
          }
        },
        "buyer_2": {
          "data": {
            "id": "id",
            "type": "buyer"
          }
        },
        "company": {
          "data": {
            "id": "id",
            "type": "company"
          }
        },
        "property": {
          "data": {
            "id": "id",
            "type": "property"
          }
        },
        "buying_agent": {
          "data": {
            "id": "id",
            "type": "connection"
          }
        },
        "selling_agent": {
          "data": {
            "id": "id",
            "type": "connection"
          }
        },
        "assignments": {
          "data": [
            {
              "id": "id",
              "type": "assignment"
            }
          ]
        },
        "custom_fields": {
          "data": [
            {
              "id": "id",
              "type": "custom_field"
            }
          ]
        },
        "inspection_attachments": {
          "data": [
            {
              "id": "id",
              "type": "inspection_attachment"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "current": 1,
      "first": 1,
      "prev": 1,
      "next": 2,
      "last": 5,
      "records": 100
    }
  },
  "links": {
    "self": "/api/v2/inspections?page[number]=1&page[size]=20",
    "current": "/api/v2/inspections?page[number]=1&page[size]=20",
    "first": "/api/v2/inspections?page[number]=1&page[size]=20",
    "prev": "/api/v2/inspections?page[number]=1&page[size]=20",
    "next": "/api/v2/inspections?page[number]=2&page[size]=20",
    "last": "/api/v2/inspections?page[number]=5&page[size]=20",
    "records": "/api/v2/inspections?page[number]=1&page[size]=20"
  }
}

json

application/json

Get an inspection

GET

https://connect-dev.spectora.com

/v2/inspections/{id}

Returns detailed information about a specific inspection.

Get an inspection › path Parameters

id

string · required

Inspection ID or slug

Get an inspection › query Parameters

include

string

fields[inspection]

string

Comma-separated list of specific fields to include in the response. Example: slug,datetime,quote,buyer_name

Get an inspection › 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.

Get an inspection › Responses

Inspection retrieved successfully

object · required

object[]

Related resources requested via the 'include' query parameter. Contains full data for relationships. Each item contains id, type, attributes, and may include its own relationships.

GET/v2/inspections/{id}

curl --request GET \
  --url https://connect-dev.spectora.com/v2/inspections/:id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": {
    "id": "12345",
    "type": "inspection",
    "attributes": {
      "slug": "4cc49466-9036-4ebf-9a0c-2249c53ab7f7",
      "datetime": "2024-03-15T14:30:00Z",
      "duration": 2.5,
      "paid": true,
      "order_id": "ORD-2024-001",
      "description": "Standard home inspection",
      "agreements_present": true,
      "agreements_signed": true,
      "notes": "Client requested focus on foundation",
      "request_notes": "Urgent - closing in 3 days",
      "published_at": "2024-03-16T10:00:00Z",
      "created_at": "2024-03-01T09:00:00Z",
      "updated_at": "2024-03-15T16:30:00Z",
      "cover_photo_url": "https://example.com/photos/cover.jpg",
      "cover_photo_thumb_url": "https://example.com/photos/cover_thumb.jpg",
      "archived_by_inspector": false,
      "deleted_at": null,
      "confirmed": true,
      "canceled_at": null,
      "datetime_formatted": "Friday, March 15, 2024 at 2:30 PM",
      "buyer_name": "John Doe",
      "full_address": "123 Main Street, Austin, TX 78701",
      "property_address": "123 Main Street",
      "property_address_2": "Unit 4B",
      "image_url": "https://example.com/properties/image.jpg",
      "quote": "450.0",
      "buying_agent_name": "Jane Smith",
      "selling_agent_name": "Bob Johnson",
      "buying_agent_email": "[email protected]",
      "buying_agent_phone": "(555) 123-4567",
      "selling_agent_email": "[email protected]",
      "selling_agent_phone": "(555) 987-6543",
      "inspector_name": "Mike Patterson",
      "buying_agent_id": 456,
      "selling_agent_id": 789,
      "service_names": "Home Inspection, Radon Testing",
      "service_add_on_names": "Thermal Imaging, Pool Inspection",
      "buyer_names": "John Doe & Jane Doe",
      "cancel_reason": "Client postponed closing date",
      "isn_id": "ISN123456",
      "payment_method_provided": true,
      "pay_at_close_display_status": "pending",
      "is_client_complete": true,
      "tooltip": "Home inspection at 123 Main St",
      "settings": {
        "source_report_view_slug": "source_report_view_slug",
        "source_inspection_copy_reports": true,
        "build_as_firestore": true,
        "enable_auto_tracks": true
      },
      "charge_at_formatted": "03/15/2024  2:30 pm",
      "referral_source": "Internet Search",
      "discount_code": "SUMMER20"
    },
    "relationships": {
      "buyer": {
        "data": {
          "id": "id",
          "type": "buyer"
        }
      },
      "buyer_2": {
        "data": {
          "id": "id",
          "type": "buyer"
        }
      },
      "company": {
        "data": {
          "id": "id",
          "type": "company"
        }
      },
      "property": {
        "data": {
          "id": "id",
          "type": "property"
        }
      },
      "buying_agent": {
        "data": {
          "id": "id",
          "type": "connection"
        }
      },
      "selling_agent": {
        "data": {
          "id": "id",
          "type": "connection"
        }
      },
      "assignments": {
        "data": [
          {
            "id": "id",
            "type": "assignment"
          }
        ]
      },
      "custom_fields": {
        "data": [
          {
            "id": "id",
            "type": "custom_field"
          }
        ]
      },
      "inspection_attachments": {
        "data": [
          {
            "id": "id",
            "type": "inspection_attachment"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "id",
      "type": "type",
      "attributes": {},
      "relationships": {}
    }
  ]
}

json

application/json

Clients

List inspections

GET

https://connect-dev.spectora.com

/v2/inspections

List inspections › query Parameters

include

string

fields[inspection]

string

Comma-separated list of specific fields to include in the response. Example: slug,datetime,quote,buyer_name

page[number]

integer

Page number (starts at 1)

page[size]

integer

Number of records per page (default: 200, max: 200)

filter[id]

string

Filter by inspection ID or slug

filter[connection_id]

integer

Filter by connection ID (matches buying agent or selling agent connections)

filter[fulltext]

string

Full-text search across inspection data (buyer name, address, agent name, etc.)

filter[datetime_greater_than]

string · date-time

Only include inspections with a date/time on or after this value. Can be used alone or combined with filter[datetime_less_than] for a date range. ISO 8601 format (e.g., '2024-01-01T00:00:00Z').

filter[datetime_less_than]

string · date-time

Only include inspections with a date/time on or before this value. Can be used alone or combined with filter[datetime_greater_than] for a date range. ISO 8601 format (e.g., '2024-12-31T23:59:59Z').

filter[paid]

boolean

Filter by payment status (true = paid, false = unpaid)

filter[agreements_signed]

boolean

Filter by whether agreements have been signed

filter[confirmed]

boolean

Filter by confirmation status

filter[canceled]

boolean

Filter by cancellation status. By default, canceled inspections are excluded. Set to true to show only canceled inspections.

filter[archived_by_inspector]

boolean

Filter by archived status. By default, archived inspections are excluded.

filter[inspector_id]

integer[]

Filter by inspector profile ID(s). Can be a single ID or an array of IDs.

filter[service_id]

integer[]

Filter by service ID(s). Returns inspections that include any of the specified services.

filter[service_category_id]

integer[]

Filter by service category ID(s). Returns inspections with services or add-ons in the specified categories.

filter[service_add_on_id]

integer[]

Filter by service add-on ID(s). Returns inspections that include any of the specified add-ons.

filter[deleted]

boolean

Filter by deletion status. By default, deleted inspections are excluded. Set to true to show only deleted inspections.

filter[published]

boolean

Filter by publication status (true = published, false = unpublished)

filter[include_canceled]

boolean

When true, includes canceled inspections in results (overrides default exclusion)

filter[include_archived_by_inspector]

boolean

When true, includes archived inspections in results (overrides default exclusion)

filter[include_deleted]

boolean

When true, includes soft-deleted inspections in results (overrides default exclusion)

filter[address]

string

Filter by property street address (case-insensitive, exact match)

filter[zip]

string

Filter by property ZIP/postal code (exact match)

filter[unit]

string

Filter by property unit number (exact match)

filter[lat]

number

Filter by property latitude (exact match, rounded to 6 decimal places)

filter[lng]

number

Filter by property longitude (exact match, rounded to 6 decimal places)

sort

string

Sort field. Prefix with '-' for descending order. Available fields: datetime, quote, confirmed, cancel_reason

List inspections › 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.

List inspections › Responses

Inspections retrieved successfully

object[] · required

object

Pagination metadata

object

Pagination links

Get an inspection

GET

https://connect-dev.spectora.com

/v2/inspections/{id}

Returns detailed information about a specific inspection.

Get an inspection › path Parameters

id

string · required

Inspection ID or slug

Get an inspection › query Parameters

include

string

fields[inspection]

string

Comma-separated list of specific fields to include in the response. Example: slug,datetime,quote,buyer_name

Get an inspection › 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.

Get an inspection › Responses

Inspection retrieved successfully

object · required

object[]

Related resources requested via the 'include' query parameter. Contains full data for relationships. Each item contains id, type, attributes, and may include its own relationships.