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 Groups API

The Groups API from Hex — 2 operation(s) for groups.

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

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

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

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

5 operations 2 paths 17 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
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 Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

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

Groups 5
GET
/v1/groups/{groupId}
GetGroup 1 param → 200400403500
DELETE
/v1/groups/{groupId}
DeleteGroup 1 param → 204400403500
PATCH
/v1/groups/{groupId}
EditGroup 1 param body → 200400403500
GET
/v1/groups
ListGroups 5 params → 200400403500
POST
/v1/groups
CreateGroup body → 201400403500

Schemas 17

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

Name
string
GroupId
string
Unique ID for a group. This can be found from the groups page (in Settings).
EnumValues_typeofListGroupsSortByEnum_
string
TraceId
string
A unique identifier for this API request. The Hex Support team may request this value when debugging an issue.
ListGroupsResponse
object
2 properties 2 required
TsoaErrorResponsePayload
object
3 properties 1 required
EnumValues_typeofSortDirectionEnum_
string
ListGroupsSortByEnum
Timestamp
string
An ISO 8601 timestamp with timezone like 1970-01-01T00:00:00Z.
ApiPaginationCursor
string
A cursor string used with before and after parameters to paginate through a list of items on the API.
LargerPageSize
integer
Number of results to fetch per page for paginated requests
PaginationApiResource
object
2 properties 2 required
CreateGroupResponse
object
3 properties 3 required
GroupMembers
object
1 property
SortDirectionEnum
UserId
string
Unique ID for a user. This can be found from the users page (in Settings).
GroupApiResource
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hexa-groups-api-openapi.yml Raw ↑

Other APIs Hex publishes across the network.

Hex Cells API
Hex Collections API
Hex Data Connections API
Hex Embedding API
Hex Guides API
Hex Projects API
Hex Semantic (projects|models) API
Hex Users API