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

HawkSoft Agencies API

Agencies and their offices

HawkSoft Agencies API is one of 5 APIs that HawkSoft publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 3.0.

Requests are made against a single base URL, https://integration.hawksoft.app.

2 operations 2 paths 2 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0
Base URL
https://integration.hawksoft.app
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

HawkSoft Agencies API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication with partner-issued credentials.

Paths & Operations 2

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

Agencies 2

Agencies and their offices

GET
/vendor/agencies
List authorized agencies
listAgencies 1 param → 200401
GET
/vendor/agency/{agencyId}/offices
List an agency's offices
listOffices 2 params → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Office (4 properties), Agency (3 properties). Each schema is shown below with its type and property counts.

Office
object
4 properties
Agency
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hawksoft-agencies-api-openapi.yml Raw ↑

Other APIs HawkSoft publishes across the network.

HawkSoft Attachments API
HawkSoft Clients API
HawkSoft Log Entries API
HawkSoft Receipts API