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 Scopes API

The Scopes API from Navigate — 2 operation(s) for scopes.

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

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

This API exposes 3 operations across 2 paths, and defines 18 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.

3 operations 2 paths 18 schemas 2 GET1 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 Scopes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth).

Paths & Operations 3

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

Scopes 3
POST
/v1/scopes
Create a scope
api_external_api_scopes_create_scope_endpoint body → 200
GET
/v1/scopes
List scopes
api_external_api_scopes_list_scopes_endpoint 3 params → 200
GET
/v1/scopes/{scope_id}
Get a scope
api_external_api_scopes_get_scope 1 param → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are LineItemRowExternalSchema (19 properties), VisitExternalSchema (15 properties), LocationExternalSchema (12 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…
AudioEvidenceExternalSchema
object
4 properties 3 required
VisitExternalSchema
object
15 properties 14 required
CostComponentExternalSchema
object
A cost component representing a portion of a line item's pricing (e.g. labor, material).
5 properties 2 required
TextEvidenceExternalSchema
object
2 properties 1 required
CreateScopeRequest
object
1 property 1 required
LineItemRowExternalSchema
object
19 properties 15 required
LineItemRoomExternalSchema
object
The room or area a line item applies to.
2 properties 1 required
LocationExternalSchema
object
12 properties 12 required
ScopeThinExternalSchema
object
Lightweight scope schema for list endpoints. Related resources are referenced by id only; fetch the full object via its own endpoint when needed. This keeps li…
4 properties 4 required
VendorOrganizationExternalSchema
object
6 properties 6 required
UserExternalSchema
object
5 properties 5 required
ScopeDetailExternalSchema
object
The full scope resource including line items, keyed by Scope.Id. This intentionally omits workflow-ish fields like status and completedby. Those semantics are…
5 properties 5 required
VisitTypeExternalSchema
object
3 properties 3 required
ListScopesResponse
object
2 properties 2 required
ImageEvidenceExternalSchema
object
6 properties 1 required
VideoExternalSchema
object
4 properties 4 required
ScopeResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

navigate-scopes-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 Scoping API
Navigate Vendors API
Navigate Video Upload Requests API