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.pm Organizations API

Organization and member management.

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

Tagged areas include Organizations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and rate-limit docs.

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

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

11 operations 6 paths 6 schemas 1 DELETE6 GET4 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://hex.pm/api
Authentication
API Key, HTTP Bearer, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 3

Hex.pm Organizations API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API token authentication. Pass the token directly: Authorization: token. For OAuth2 Bearer tokens use: Authorization: Bearer token.
  • BearerAuth — OAuth2 Bearer token obtained via Device Authorization Grant (RFC 8628).
  • BasicAuth — Deprecated. Basic authentication with username and password. Only allowed on specific endpoints for generating API tokens.

Paths & Operations 11

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

Organizations 11

Organization and member management.

GET
/orgs
List all Organizations
listOrganizations 1 param → 200
GET
/orgs/{name}
Fetch an Organization
getOrganization 1 param → 200404
POST
/orgs/{name}
Update an Organization
updateOrganization 1 param body → 200
GET
/orgs/{name}/audit-logs
Fetch Organization Audit Logs
getOrganizationAuditLogs 2 params → 200
GET
/orgs/{name}/members
List Organization Members
listOrganizationMembers 2 params → 200
POST
/orgs/{name}/members
Add Organization Member
addOrganizationMember 1 param body → 204422
GET
/orgs/{name}/members/{username}
Get Organization Member
getOrganizationMember 2 params → 200404
POST
/orgs/{name}/members/{username}
Update Organization Member
updateOrganizationMember 2 params body → 204
DELETE
/orgs/{name}/members/{username}
Remove Organization Member
removeOrganizationMember 2 params → 204404
GET
/orgs/{name}/keys
List Organization API Keys
listOrganizationApiKeys 1 param → 200
POST
/orgs/{name}/keys
Create Organization API Key
createOrganizationApiKey 1 param body → 201422

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ApiKey (7 properties), Organization (6 properties), AuditLog (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

ApiKeyCreate
object
2 properties 2 required
AuditLog
object
4 properties
ApiKey
object
7 properties
OrganizationMember
object
3 properties
Error
object
3 properties 2 required
Organization
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hex-pm-organizations-api-openapi.yml Raw ↑

Other APIs Hex.pm publishes across the network.

Hex.pm API Keys API
Hex.pm Authentication API
Hex.pm Documentation API
Hex.pm Index API
Hex.pm OAuth API
Hex.pm Package Owners API
Hex.pm Packages API
Hex.pm Releases API
Hex.pm Repositories API
Hex.pm Users API
Hex.pm Utilities API