How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RunWhen users API

The users API from RunWhen — 17 operation(s) for users.

RunWhen users API is one of 51 APIs that RunWhen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 18 operations across 17 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://papi.beta.runwhen.com.

18 operations 17 paths 20 schemas 10 GET1 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://papi.beta.runwhen.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

RunWhen users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JWT access token from /api/v3/token/ or Auth0 login

Paths & Operations 18

Across 17 paths, the API surfaces 18 operations — 10 GET, 1 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

users 18
POST
/api/v3/users/register
Register a new user account
register_api_v3_users_register_post body → 201422
POST
/api/v3/users/verify-email
Verify email address via token
verify_email_api_v3_users_verify_email_post body → 200422
POST
/api/v3/users/resend-verification
Resend verification email
resend_verification_api_v3_users_resend_verification_post body → 200422
POST
/api/v3/users/forgot-password
Request a password reset email
forgot_password_api_v3_users_forgot_password_post body → 200422
POST
/api/v3/users/reset-password
Reset password using a token
reset_password_api_v3_users_reset_password_post body → 200422
GET
/api/v3/users/csrf-token
Get CSRF token
get_csrf_token_api_v3_users_csrf_token_get → 200
POST
/api/v3/users/login
Login with username and password
login_api_v3_users_login_post body → 200422
POST
/api/v3/users/logout
Logout (invalidate session)
logout_api_v3_users_logout_post → 204
GET
/api/v3/users/whoami
Get current user info
whoami_api_v3_users_whoami_get → 200
GET
/api/v3/users/search
Search users by name or email
search_users_api_v3_users_search_get 2 params → 200422
GET
/api/v3/users/search-email
Search users by exact email
search_users_by_email_api_v3_users_search_email_get 1 param → 200422
GET
/api/v3/users/get-token
Get access token for API usage
get_token_api_v3_users_get_token_get 1 param → 200422
GET
/api/v3/users/my-network
Get users in current user's network
get_my_network_api_v3_users_my_network_get 1 param → 200422
GET
/api/v3/users/{user_id}
Get user by ID
get_user_api_v3_users__user_id__get 1 param → 200422
PATCH
/api/v3/users/{user_id}
Update user details
update_user_api_v3_users__user_id__patch 1 param body → 200422
GET
/api/v3/users/{user_id}/activeworkspaces
Get user's active workspaces
get_user_active_workspaces_api_v3_users__user_id__activeworkspaces_get 1 param → 200422
GET
/api/v3/users/{user_id}/activities/count
Get count of user's activities
get_user_activities_count_api_v3_users__user_id__activities_count_get 1 param → 200422
GET
/api/v3/users/{user_id}/activities
Get user's activity stream
get_user_activities_api_v3_users__user_id__activities_get 3 params → 200422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are UserResponse (17 properties), UserSearchResponse (9 properties), RegisterRequest (6 properties), UserUpdateRequest (6 properties). Each schema is shown below with its type and property counts.

VerifyEmailRequest
object
Email verification request.
1 property 1 required
CsrfTokenResponse
object
CSRF token response.
1 property 1 required
HTTPValidationError
object
1 property
UserActiveWorkspacesResponse
object
Response for user's active workspaces with activity count.
2 properties 2 required
UserNetworkResponse
object
Response schema for users in the current user's network.
5 properties 2 required
UserResponse
object
User response schema matching Django's UserSerializer.
17 properties 2 required
GroupResponse
object
Minimal group info returned inside UserResponse.
2 properties 2 required
ResetPasswordRequest
object
Password reset request. Accepts both 'password' (frontend sends this) and 'newpassword' for backward compatibility.
4 properties 1 required
UserTokenResponse
object
Response for token generation.
2 properties 2 required
UserSearchEmailResponse
object
Response for email search including not found emails.
2 properties 1 required
UserActivitiesCountResponse
object
Response for user activities count (heatmap data).
2 properties 2 required
UserUpdateRequest
object
Request schema for updating user details. Accepts both camelCase (from UI) and snakecase field names.
6 properties
LoginRequest
object
Username/password login request.
2 properties 2 required
UserSearchResponse
object
Response for user search results.
9 properties 2 required
ForgotPasswordRequest
object
Forgot password request.
1 property 1 required
RegisterResponse
object
User registration response.
4 properties 4 required
ValidationError
object
5 properties 3 required
LoginResponse
object
Login response with tokens.
3 properties 3 required
RegisterRequest
object
User registration request.
6 properties 2 required
MessageResponse
object
Generic message response.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runwhen-users-api-openapi.yml Raw ↑

Other APIs RunWhen publishes across the network.

RunWhen alert-query-proxy API
RunWhen auth API
RunWhen auth-providers API
RunWhen auth0 API
RunWhen author API
RunWhen chat-config API
RunWhen codebundles API
RunWhen codecollections API
RunWhen comments API
RunWhen configuration API
RunWhen explorer API
RunWhen Graphql API
Where this information came from

This is an independent, third-party profile of RunWhen users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.