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

Hilos Contact API

The Contact API from Hilos — 2 operation(s) for contact.

Hilos Contact API is one of 6 APIs that Hilos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contact. The published artifact set on APIs.io includes an OpenAPI specification.

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

Requests are made against a single base URL, https://api.hilos.io.

6 operations 2 paths 11 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.hilos.io/api/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Hilos Contact API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 6

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

Contact 6
GET
/api/contact
List contacts
List Contacts 3 params → 200
POST
/api/contact
Create a contact
Create or Update Contact body → 201
DELETE
/api/contact/{id}
Delete Contact
Delete Contact Operation ID 1 param → 204
GET
/api/contact/{id}
Get Contact
Get Contact 1 param → 200
PATCH
/api/contact/{id}
Partially Update Contact
Partial Update Contact 1 param body → 200
PUT
/api/contact/{id}
Update Contact
Update Contact 1 param body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ContactDetailRead (20 properties), ContactDetailReadPublic (16 properties), PatchedContactEditPublic (14 properties), ContactListReadPublic (13 properties). Each schema is shown below with its type and property counts.

PaginatedContactListReadPublicList
object
4 properties
UserRoleEnum
string
ContactDetailRead
object
20 properties 11 required
SimpleUser
object
6 properties 1 required
ContactTag
object
2 properties 2 required
ContactNoteRead
object
5 properties 4 required
AccountMemberUserBasicRead
object
7 properties 7 required
InboxContactURL
object
3 properties 2 required
ContactListReadPublic
object
13 properties 8 required
PatchedContactEditPublic
object
14 properties
ContactDetailReadPublic
object
16 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hilos-contact-api-openapi.yml Raw ↑

Other APIs Hilos publishes across the network.

Hilos Conversation API
Hilos Flow Execution API
Hilos Flow Execution Contact API
Hilos User API
Hilos WhatsApp API