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

Hatch contacts API

The contacts API from Hatch — 1 operation(s) for contacts.

Hatch contacts API is published by Hatch on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://api.usehatchapp.com.

2 operations 1 paths 3 schemas 1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.usehatchapp.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Hatch contacts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (authorization). By default, every request must be authenticated.

Paths & Operations 2

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

contacts 2
POST
/v1/contacts
Upsert a contact.
HatchWeb.V1.Integrations.ContactController.upsert (2) body → 200422
PUT
/v1/contacts
Upsert a contact.
HatchWeb.V1.Integrations.ContactController.upsert body → 200422

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are UpsertContactParams (11 properties), UpsertContactSuccessfulResponse (1 property), JsonErrorResponse (1 property). Each schema is shown below with its type and property counts.

JsonErrorResponse
object
1 property 1 required
UpsertContactParams
object
The attributes for upserting a contact.
11 properties
UpsertContactSuccessfulResponse
object
Response for upserting a contact with success
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hatch-contacts-api-openapi.yml Raw ↑