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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Charthop

Charthop user API

The user API from Charthop — 15 operation(s) for user.

Documentation Provider Profile APIs.io OpenAPI GitHub

Charthop user API is one of 87 APIs that Charthop 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 and API documentation.

This API exposes 17 operations across 15 paths, and defines 24 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

Requests are made against the base URL https://api.charthop.com.

17 operations 15 paths 24 schemas 2 DELETE8 GET2 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
V1.0.0
Base URL
https://api.charthop.com
Contact
ChartHop
Resource Areas
1

Paths & Operations 17

Across 15 paths, the API surfaces 17 operations — 2 DELETE, 8 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

user 17
GET
/v1/user
Return all users within an org or across orgs
findUsers 9 params → 200400404
POST
/v1/user
Create a new user
createUser 1 param → 201400401403
PATCH
/v1/user/assign
Assign or remove multiple users a role within an org
assignUsers 1 param → 400401403404
GET
/v1/user/count
Count users matching the same filters as findUsers, broken down by invite status
countUsers 4 params → 200400403404
GET
/v1/user/email/{email}
Return a particular user by email
getUserByEmail 1 param → 200400404
POST
/v1/user/invite
Create/invite multiple new users
createUsers 1 param → 201400401403404
GET
/v1/user/login/{email}
Return the login options for a user
getUserLoginOption 2 params → 200
GET
/v1/user/me
Return the currently logged in user
getMe → 200401
GET
/v1/user/me/view
Return the user the user is currently viewing as
getMeView → 200401
GET
/v1/user/person/{personId}
Return a particular user by its corresponding person id
getUserByPersonId 2 params → 200400404
POST
/v1/user/sendreset
Send a password reset email
sendResetEmail 1 param → 204400
DELETE
/v1/user/token
Revoke multiple user's access tokens
revokeUsersTokens 1 param → 400401403404
GET
/v1/user/{userId}
Return a particular user by id
getUser 1 param → 200400404
PATCH
/v1/user/{userId}
Update an existing user
updateUser 2 params → 204400401403404
POST
/v1/user/{userId}/password
Change a user's password, or switch a user to SSO
changePassword 2 params → 204400401403404
DELETE
/v1/user/{userId}/token
Revoke a user's access token
revokeUserToken 1 param → 401404
POST
/v2/user/invite
Create/invite multiple new users
inviteUsersToOrg 1 param → 200400401403404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are User (35 properties), AiAgentConfig (14 properties), CreateUser (14 properties), UpdateUser (13 properties). Each schema is shown below with its type and property counts.

OrgAccess
object
11 properties 2 required
TargetedInstruction
object
2 properties 2 required
PolicyRuleTarget
object
4 properties
ResultsUser
object
3 properties 1 required
User
object
35 properties 2 required
AiAgentConfig
object
14 properties
BundleInstallEntity
object
3 properties 3 required
AccessAction
object
3 properties 1 required
InviteUsersRequest
object
2 properties 1 required
ChangePasswordRequest
object
2 properties 1 required
UpdateUser
object
13 properties
Attribution
object
6 properties
BundleInstall
object
1 property 1 required
ResultsAccess
object
2 properties 1 required
EmailRequest
object
1 property 1 required
MessagingConfig
object
3 properties
WebRegisteredCredential
object
5 properties 5 required
UserEmailSetting
object
2 properties 2 required
CreateUser
object
14 properties 1 required
ShareAccess
object
4 properties 1 required
WelcomeEmailSettings
object
4 properties 4 required
PolicyRule
object
11 properties
Name
object
5 properties 1 required
UserCount
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-user-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
AE Profile APIs.io
Charthop action API
AE Profile APIs.io
Charthop ai API
AE Profile APIs.io
Charthop ai-credit-limit API
AE Profile APIs.io
Charthop ai-hint API
AE Profile APIs.io
Charthop ai-prompt API
AE Profile APIs.io
Charthop app API
AE Profile APIs.io
Charthop appConfig API
AE Profile APIs.io
Charthop approval API
AE Profile APIs.io
Charthop approval-delegate API
AE Profile APIs.io
Charthop approval-request API
AE Profile APIs.io
Charthop assessment API
AE Profile APIs.io
#user
← Back to C APIs
API Details
ID
charthop:charthop-user-api
Base URL
https://api.charthop.com
Docs
https://docs.charthop.com/charthop-for-developers
Provider
Charthop
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network