Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Navigate Visits API

The Visits API from Navigate — 7 operation(s) for visits.

Navigate Visits API is one of 16 APIs that Navigate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Visits. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 7 operations across 7 paths, and defines 17 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.navigateai.co.

7 operations 7 paths 17 schemas 3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.navigateai.co
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Navigate Visits API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth).

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Visits 7
GET
/v1/location/{location_id}/visits
List all visits for a location
api_external_api_location_get_all_visits_for_location 1 param → 200
GET
/v1/visits/{visit_id}
Get a visit
api_external_api_visit_get_visit 1 param → 200
POST
/v1/visits/{visit_id}/access_grants
Create a visit access grant
api_external_api_visit_create_visit_access_grant_endpoint 1 param body → 200
POST
/v1/visits
Create a new visit to accept video upload requests
api_external_api_visit_create_visit body → 201
POST
/v1/visits/{visit_id}/process
Start processing a visit
api_external_api_visit_process_visit 1 param → 200
POST
/v1/visits/{visit_id}/cancel
Cancel a visit
api_external_api_visit_cancel_visit 1 param → 200
GET
/v1/visits/{visit_id}/findings
List findings for a visit (Beta)
api_external_api_visit_list_findings 1 param → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are VisitExternalSchema (15 properties), FindingExternalSchema (7 properties), VisitAccessGrantResponse (6 properties), ImageEvidenceExternalSchema (6 properties). Each schema is shown below with its type and property counts.

ExternalVisitRequestStatus
string
Customer facing visit statuses. Each VisitRequestStatus should map directly to a ExternalVisitRequestStatus. But we don't need ExternalVisitRequestStatus to di…
ListFindingsResponse
object
1 property 1 required
AudioEvidenceExternalSchema
object
4 properties 3 required
VisitExternalSchema
object
15 properties 14 required
TextEvidenceExternalSchema
object
2 properties 1 required
CreateVisitRequest
object
3 properties 2 required
FindingExternalSchema
object
7 properties 7 required
AllVisitsForLocationResponse
object
1 property 1 required
CreateVisitAccessGrantRequest
object
4 properties
ProcessVisitResponse
object
1 property 1 required
VisitResponse
object
1 property 1 required
UserExternalSchema
object
5 properties 5 required
VisitTypeExternalSchema
object
3 properties 3 required
ImageEvidenceExternalSchema
object
6 properties 1 required
VisitAccessGrantResponse
object
6 properties 6 required
VideoExternalSchema
object
4 properties 4 required
CancelVisitResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

navigate-visits-api-openapi.yml Raw ↑

Other APIs Navigate publishes across the network.

Navigate Access codes API
Navigate Assets API
Navigate Lennar API
Navigate Line items API
Navigate Locations API
Navigate Markets API
Navigate Rejection reason options API
Navigate Room types API
Navigate Rooms API
Navigate Scopes API
Navigate Scoping API
Navigate Vendors API