# PipesHub Users API

**Canonical:** https://apis.io/apis/pipeshub/pipeshub-users-api/  
**Provider:** PipesHub — https://apis.io/providers/pipeshub/  
**Base URL:** https://app.pipeshub.com/api/v1  
**Documentation:** https://docs.pipeshub.com/developer/api-reference

PipesHub Users API is one of 51 APIs that [PipesHub](https://apis.io/providers/pipeshub/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

User management operations

## Operations (24)

| Method | Path | Summary |
|---|---|---|
| GET | `/users/health` | Users module health check |
| GET | `/users` | Get all users |
| POST | `/users` | Create a new user |
| GET | `/users/{id}` | Get user by ID |
| PUT | `/users/{id}` | Update user |
| DELETE | `/users/{id}` | Delete user |
| GET | `/users/{id}/email` | Get user email by ID |
| PATCH | `/users/{id}/email` | Request an email address change |
| PUT | `/users/dp` | Upload display picture |
| GET | `/users/dp` | Get display picture |
| DELETE | `/users/dp` | Remove display picture |
| POST | `/users/bulk/invite` | Bulk invite users |
| POST | `/users/bulk/invite/upload` | Bulk invite users from a CSV/Excel file |
| POST | `/users/{id}/resend-invite` | Resend user invite |
| GET | `/users/graph/list` | List users (paginated, enriched) |
| PUT | `/users/{id}/unblock` | Unblock a user in organization |
| GET | `/users/fetch/with-groups` | Get all users with groups |
| POST | `/users/by-ids` | Get users by IDs |
| PATCH | `/users/{id}/fullname` | Update user full name |
| PATCH | `/users/{id}/firstName` | Update user first name |
| PATCH | `/users/{id}/lastName` | Update user last name |
| PATCH | `/users/{id}/designation` | Update user designation |
| GET | `/users/{id}/adminCheck` | Check if requester is admin |
| GET | `/users/me/role` | Get the requester's role |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/openapi/pipeshub-users-api-openapi.yml
- **Documentation** — https://docs.pipeshub.com/developer/api-reference
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-get-record-by-id-response-schema-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-record-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-knowledge-hub-nodes-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-agent-create-conversation-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-conversation-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-create-conversation-request-schema.json

## Other PipesHub APIs (12)

- [PipesHub Agents API](https://apis.io/apis/pipeshub/pipeshub-agents-api/)
- [PipesHub AI Models Providers API](https://apis.io/apis/pipeshub/pipeshub-ai-models-providers-api/)
- [PipesHub Authentication Configuration API](https://apis.io/apis/pipeshub/pipeshub-authentication-configuration-api/)
- [PipesHub Configuration Manager API](https://apis.io/apis/pipeshub/pipeshub-configuration-manager-api/)
- [PipesHub Connector API](https://apis.io/apis/pipeshub/pipeshub-connector-api/)
- [PipesHub Connector Configuration API](https://apis.io/apis/pipeshub/pipeshub-connector-configuration-api/)
- [PipesHub Connector Control API](https://apis.io/apis/pipeshub/pipeshub-connector-control-api/)
- [PipesHub Connector Filters API](https://apis.io/apis/pipeshub/pipeshub-connector-filters-api/)
- [PipesHub Connector Instances API](https://apis.io/apis/pipeshub/pipeshub-connector-instances-api/)
- [PipesHub Connector OAuth API](https://apis.io/apis/pipeshub/pipeshub-connector-oauth-api/)
- [PipesHub Connector Registry API](https://apis.io/apis/pipeshub/pipeshub-connector-registry-api/)
- [PipesHub Connectors API](https://apis.io/apis/pipeshub/pipeshub-connectors-api/)

## Tags

Users

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/pipeshub/pipeshub-users-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/pipeshub/.