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 Flow Execution Contact API

The Flow Execution Contact API from Hilos — 2 operation(s) for flow execution contact.

Hilos Flow Execution 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 Flow Execution Contact. The published artifact set on APIs.io includes an OpenAPI specification.

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

2 operations 2 paths 51 schemas 2 GET

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 Flow Execution 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 2

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

Flow Execution Contact 2
GET
/api/flow-execution-contact
List Flow Execution Contacts
List Flow Execution Contact 10 params → 200
GET
/api/flow-execution-contact/{id}
Get Flow Execution Contact by Id
Get Flow Execution Contact 1 param → 200

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are FlowStepEdit (68 properties), WhatsAppMessage (29 properties), FlowExecutionReadDetail (24 properties), FlowVersionSimpleRead (16 properties). Each schema is shown below with its type and property counts.

FlowExecutionContactStatusEnum
string
BodyFileTypeEnum
string
FlowStepEdit
object
This class is not useful other than for the OpenAPI Schema.
68 properties 11 required
FlowExecutionContactReadDetail
object
7 properties 3 required
InboundTriggerWithEnum
string
FlowExecutionTypeEnum
string
ComparisonEnum
string
FlowExecutionContactListSimple
object
7 properties 3 required
FlowVersionSimpleRead
object
16 properties 5 required
WhatsAppMessage
object
29 properties 28 required
WhatsAppTemplateStatusEnum
string
MaxWaitTimeUnitEnum
string
ChannelTypeEnum
string
FlowExecutionContactFilterEdit
object
4 properties 3 required
FlowExecutionStepReadDetail
object
11 properties 2 required
MessageTypeEnum
string
WeekdayEnum
integer
UploadedAccountFile
object
5 properties 3 required
MessageStatusEnum
string
ChannelStatusEnum
string
FlowStepTimeWindow
object
4 properties 1 required
ChannelProviderEnum
string
AnswerTypeEnum
string
PaginatedFlowExecutionContactListSimpleList
object
4 properties
StepConditionalCondition
object
4 properties 4 required
ContactMessage
object
7 properties
FlowExecutionStatusEnum
string
FlowExecutionExecuteForEnum
string
StepConditionalMultilpePath
object
1 property 1 required
TimeWindowTypeEnum
string
LanguageEnum
string
FlowStatusEnum
string
UserRoleEnum
string
BlankEnum
ActionRequestMethodEnum
string
FlowSimpleRead
object
9 properties 4 required
FlowStepContactUpdateCustomProperty
object
2 properties 2 required
SimpleUser
object
6 properties 1 required
AnswerPhoneDefaultCountryEnum
string
FlowExecutionStepWhatsAppMessage
object
1 property 1 required
WhatsAppTemplateSimpleRead
object
9 properties 5 required
FlowExecutionReadDetail
object
24 properties 7 required
LocationMessage
object
6 properties 3 required
ContactReadSimple
object
12 properties 5 required
FlowExecutionStepReadDetailStatusEnum
string
MessageSourceEnum
string
FlowExecutionExecutionTypeEnum
string
CategoryEnum
string
AnswerOptionsRenderEnum
string
SimpleChannel
object
8 properties 2 required
NullEnum

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hilos-flow-execution-contact-api-openapi.yml Raw ↑

Other APIs Hilos publishes across the network.

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