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

Customer account records.

Joblogic Customers API is one of 9 APIs that Joblogic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

7 operations 4 paths 7 schemas 1 DELETE2 GET2 POST2 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 Customers 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 7

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

Customers 7

Customer account records.

POST
/Customer/GetAll
Search customers
searchCustomers body → 200401429
GET
/Customer
Get a customer by unique ID
getCustomerByUniqueId 3 params → 200401404
POST
/Customer
Create a customer
createCustomer body → 200401422
PUT
/Customer
Update a customer
updateCustomer body → 200401
DELETE
/Customer
Delete a customer
deleteCustomer 2 params → 200401404
GET
/Customer/GetById
Get a customer by integer ID
getCustomerById 3 params → 200401
PUT
/Customer/SetStatus
Set customer status
setCustomerStatus body → 200401

Schemas 7

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

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
CustomerList
PagedResult
object
4 properties
Address
object
6 properties
Customer
object
8 properties
SetStatusRequest
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

joblogic-customers-api-openapi.yml Raw ↑

Other APIs Joblogic publishes across the network.

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