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

Hex Users API

The Users API from Hex — 3 operation(s) for users.

Hex Users API is one of 11 APIs that Hex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

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

Requests are made against a single base URL, https://app.hex.tech/api.

3 operations 3 paths 5 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://app.hex.tech/api/v1
Authentication
HTTP Bearer
License
UNLICENSED
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 3

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

Users 3
GET
/v1/users/me
Me
Me → 200400401403404500
GET
/v1/users
ListUsers
ListUsers 7 params → 200400401403404500
POST
/v1/users/{userId}/deactivate
DeactivateUser
DeactivateUser 1 param → 200400401403500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are error.FORBIDDEN (3 properties), error.INTERNAL_SERVER_ERROR (3 properties), error.NOT_FOUND (3 properties), error.UNAUTHORIZED (3 properties). Each schema is shown below with its type and property counts.

error.BAD_REQUEST
object
The error information
3 properties 2 required
error.UNAUTHORIZED
object
The error information
3 properties 2 required
error.NOT_FOUND
object
The error information
3 properties 2 required
error.INTERNAL_SERVER_ERROR
object
The error information
3 properties 2 required
error.FORBIDDEN
object
The error information
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hex-users-api-openapi.yml Raw ↑

Other APIs Hex publishes across the network.

Hex Cells API
Hex Collections API
Hex Context API
Hex Data Connections API
Hex Embedding API
Hex Groups API
Hex Guides API
Hex Projects API
Hex Semantic (projects|models) API
Hex Threads API