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

Joblogic Visits API

Engineer visits scheduled against jobs.

Joblogic Visits API is one of 9 APIs that Joblogic 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, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against 2 base URLs: https://api.joblogic.com/api/v1, https://uatapi.joblogic.com/api/v1.

6 operations 4 paths 5 schemas 1 DELETE1 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.joblogic.com/api/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Joblogic Visits API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

  • oauth2ClientCredentials — OAuth2 client-credentials grant against the Joblogic IdentityServer. The confirmed UAT token endpoint is https://uatidentityserver.joblogic.com/connect/token;…

Paths & Operations 6

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

Visits 6

Engineer visits scheduled against jobs.

POST
/Visit/GetAll
Retrieve all visits
searchVisits body → 200401
POST
/Visit
Create a visit
createVisit body → 200401
PUT
/Visit
Update a visit
updateVisit body → 200401
DELETE
/Visit
Delete a visit
deleteVisit 2 params → 200401
GET
/Visit/GetById
Retrieve a visit by integer ID
getVisitById 2 params → 200401
POST
/Visit/Deploy
Deploy a visit to an engineer
deployVisit body → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Visit (7 properties), SearchRequest (6 properties), PagedResult (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

VisitList
Error
object
3 properties
SearchRequest
object
Common search envelope used by the /GetAll and /getall endpoints. Fields shown are representative; consult the live documentation for the exact filters support…
6 properties
PagedResult
object
4 properties
Visit
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

joblogic-visits-api-openapi.yml Raw ↑

Other APIs Joblogic publishes across the network.

Joblogic Assets API
Joblogic Contacts API
Joblogic Customers API
Joblogic Engineers API
Joblogic Invoices API
Joblogic Jobs API
Joblogic Quotes API
Joblogic Sites API