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

Docupilot user API

The user API from Docupilot — 8 operation(s) for user.

Docupilot user API is one of 40 APIs that Docupilot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 1 JSON Schema.

This API exposes 10 operations across 8 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api-us1.docupilot.app.

10 operations 8 paths 15 schemas 4 GET1 PATCH2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api-us1.docupilot.app
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Docupilot user API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (OAuthAuthentication). An API key is passed in the cookie as sessionid (SessionAuthentication).

  • OAuthAuthentication — OAuth2 Bearer Token Authentication
  • SessionAuthentication — browser based login takes care of this

Paths & Operations 10

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

user 10
PUT
/accounts/user/change_email/
change_email body → 204400401
PUT
/accounts/user/change_password/
change_password body → 204400401
GET
/accounts/user/config_meta/
User config meta
user_config_meta → 200401403
GET
/accounts/user/detail/{guid}/
get logged in user details
get_use_by_guid 1 param → 200401
POST
/accounts/user/initiate_authorization_sequence/
initiate_authorization_sequence body → 204400401403
GET
/accounts/user/me/
get logged in user details
get_me → 200401
PUT
/accounts/user/me/
update logged in user details
update_me body → 200400401
PATCH
/accounts/user/me/
partial update user details
partial_update_user_details body → 200400401
GET
/accounts/user/organizations/
Get all organizations for the current user
get_user_organizations 1 param → 200401403
POST
/accounts/user/verify_authorization/
verify_authorization body → 204400401403

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are User (14 properties), PatchedUser (14 properties), Organization (9 properties), Workspace (7 properties). Each schema is shown below with its type and property counts.

UnauthenticatedError
object
1 property 1 required
UserOrganization
object
6 properties 3 required
UserMeta
object
2 properties 2 required
VerifyAuthorizationOTP
object
1 property 1 required
ChangePassword
object
3 properties 2 required
TimeZone
object
3 properties 3 required
Locale
object
2 properties 2 required
SendAuthorizationOTP
object
1 property 1 required
PatchedUser
object
14 properties
ChangeEmail
object
2 properties 2 required
User
object
14 properties 9 required
Workspace
object
7 properties 6 required
ValidationError
object
2 properties 2 required
ForbiddenError
object
1 property 1 required
Organization
object
9 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

docupilot-user-api-openapi.yml Raw ↑

Other APIs Docupilot publishes across the network.

Docupilot ai API
Docupilot append API
Docupilot application API
Docupilot auth_tokens API
Docupilot community API
Docupilot content_blocks API
Docupilot convert API
Docupilot demographic API
Docupilot domain API
Docupilot esign API
Docupilot esign-folders API
Docupilot esign-settings API
Where this information came from

This is an independent, third-party profile of Docupilot user 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.