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

HumanAPI users API

The users API from HumanAPI — 4 operation(s) for users.

HumanAPI users API is one of 7 APIs that HumanAPI 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.

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

Requests are made against a single base URL, https://admin.humanapi.co.

5 operations 4 paths 15 schemas 3 GET2 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://admin.humanapi.co
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 5

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

users 5
GET
/api/v1/users
Get the list of all active users
getUsersList 3 params → 200401404
POST
/api/v1/users
Create a new user
createUser body → 201202400401404409
POST
/api/v1/users/actions
Performs an action for a given user
performActionForUser body → 202400401404409
GET
/api/v1/users/{humanId}
Get the details of a specific user (by humanId)
getUserDetails 1 param → 200401404
GET
/api/v1/users/providers
Retrieve the list of providers for a given user
userProviders 2 params → 200400401404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are newUser (17 properties), user (10 properties), t11mUser (10 properties), provider (8 properties). Each schema is shown below with its type and property counts.

orderInfo
object
5 properties
newUser
object
17 properties 1 required
t11mUser
object
10 properties
actionForUserClientUserId
object
2 properties 2 required
user
object
10 properties 5 required
actionForUserHumanId
object
2 properties 2 required
provider
object
8 properties 2 required
performActionForUser
errorInvalidInput
object
5 properties 5 required
providersResponse
array
address
object
5 properties 4 required
error
object
4 properties 4 required
orderInfoWithDataAvailable
object
6 properties
actionForUsersActionAttribute
string
attachment
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanapi-users-api-openapi.yml Raw ↑

Other APIs HumanAPI publishes across the network.

HumanAPI admin API
HumanAPI connect API
HumanAPI orders API
HumanAPI reports API
HumanAPI resources API
HumanAPI subscriptions API