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

Weavix User Management API

The User Management API from Weavix — 5 operation(s) for user management.

Weavix User Management API is one of 8 APIs that Weavix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 6 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.weavix.com.

6 operations 5 paths 2 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.weavix.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Weavix User Management API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Account API key passed as the Authorization request header. Keys are created in the weavix Console under Configuration - API Keys (Secret + Authorization Token…

Paths & Operations 6

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

User Management 6
GET
/core/people/names
Get a list of all users on the account
listUsers → 200
GET
/v1/core/people
List people (v1)
listPeople → 200
GET
/core/users/{id}
Get a user
getUser 1 param → 200
DELETE
/core/people/{id}
Delete a user
deleteUser 1 param → 200
PUT
/core/people/{id}
Update a user
updateUser 1 param body → 200
POST
/core/people/new-user
Add a user
createUser body → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are UserCreate (9 properties), UserUpdate (8 properties). Each schema is shown below with its type and property counts.

UserUpdate
object
8 properties
UserCreate
object
9 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavix-user-management-api-openapi.yml Raw ↑

Other APIs Weavix publishes across the network.

Weavix Channels & Messaging API
Weavix Crafts API
Weavix Forms API
Weavix Geofences API
Weavix Mass Alerts API
Weavix Permission Groups API
Weavix Sites API