Jump to Content
API Reference
v1
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Django + Core
API Reference
Get my user
Search
JUMP TO
Pitcher API
Apps
List apps
get
Delete app
delete
Install app
post
Publish app
post
Apps DB
Get a global-scoped entry
get
Upsert a global-scoped entry
put
Delete a global-scoped entry
delete
Get a user-scoped entry
get
Upsert a user-scoped entry
put
Delete a user-scoped entry
delete
Bulk Operations
Bulk delete mixed objects
post
Bulk update metadata
post
Bulk update tags
post
Bulk delete canvases
post
Bulk delete favorites
post
Bulk delete folders
post
Canvases
List canvases
get
Create canvas
post
Get canvas
get
Update canvas
put
Partial update canvas
patch
Delete canvas
delete
Update canvas indicators
patch
Get recommended files for canvas
get
Restore canvas
post
Get specific canvases by IDs
post
List deleted canvases
get
Collaborations
List collaborations
get
Create collaboration
post
Get collaboration
get
Update collaboration
put
Partial update collaboration
patch
Delete collaboration
delete
Content Distribution Group Memberships
List content distribution group memberships
get
Create content distribution group membership
post
Get content distribution group membership
get
Update content distribution group membership
put
Partial update content distribution group membership
patch
Delete content distribution group membership
delete
Content Distribution Groups
List content distribution groups
get
Create content distribution group
post
Get content distribution group
get
Update content distribution group
put
Partial update content distribution group
patch
Delete content distribution group
delete
Restore content distribution group
post
List deleted content distribution groups
get
Environments
List environments
get
Create environment
post
Get environment
get
Update environment
put
Partial update environment
patch
Delete environment
delete
Restore environment
post
List deleted environments
get
Events
List events
get
Create event
post
Get event
get
Update event
put
Partial update event
patch
Delete event
delete
Favorites
List favorites
get
Create favorite
post
Get favorite
get
Update favorite
put
Partial update favorite
patch
Delete favorite
delete
Restore favorite
post
List deleted favorites
get
Files
List files
get
Create file
post
Get file
get
Update file
put
Partial update file
patch
Delete file
delete
Bulk delete files
post
Get file analytics
get
Publish file
patch
Restore file
post
List deleted files
get
File Revisions
List file revisions
get
Update file revision
put
Partially updates file revision
patch
Retrieve file revision data
get
Revert file revision
post
Folders
List folders
get
Create folder
post
Get folder
get
Update folder
put
Get root folder
get
Partial update folder
patch
Delete folder
delete
Restore folder
post
List deleted folders
get
Folder Shortcuts
Get canvas templates folder
get
Get personal canvases folder
get
Get personal files folder
get
Instance Assignment Group Memberships
List instance assignment group memberships
get
Create instance assignment group membership
post
Get instance assignment group membership
get
Update instance assignment group membership
put
Partial update instance assignment group membership
patch
Delete instance assignment group membership
delete
Instance Assignment Groups
List instance assignment groups
get
Create instance assignment group
post
Get instance assignment group
get
Update instance assignment group
put
Partial update instance assignment group
patch
Delete instance assignment group
delete
Restore instance assignment group
post
List deleted instance assignment groups
get
Instance Memberships
List instance memberships
get
Create instance membership
post
Get instance membership
get
Update instance membership
put
Partial update instance membership
patch
Delete instance membership
delete
Instances
List instances
get
Create instance
post
Get instance
get
Update instance
put
Partial update instance
patch
Delete instance
delete
Get instance analytics
get
Create instance login
post
Restore instance
post
List deleted instances
get
Invitations
List invitations
get
Create invitation
post
Get invitation
get
Delete invitation
delete
Languages
List languages
get
Metadata Templates
List metadata templates
get
Create metadata template
post
Get metadata template
get
Update metadata template
put
Partial update metadata template
patch
Delete metadata template
delete
Restore metadata template
post
List deleted metadata templates
get
Metadata Template Revisions
List metadata template revisions
get
Update metadata template revision
put
Revert metadata template revision
post
Offline Sync
Sync folders
get
Organization
Get organization details
get
Update organization details
put
Partially update organization details
patch
Get organization analytics
get
PSPDFKit
Get document info
get
Get image
get
Create pdf token
post
Regions
List regions
get
Create region
post
Get region
get
Update region
put
Partial update region
patch
Delete region
delete
Restore region
post
List deleted regions
get
Search
Search for content
get
Shared Links
Create shared link
post
Get shared link
get
Shared Links (Canvas)
Get shared link for canvas
get
Remove shared link from canvas
delete
Shared Links (File)
Get shared link for file
get
Remove shared link from file
delete
Tags
Get all instance tags
get
test-db
/api/v1/test-db/
get
Tokens
List user tokens
get
Create user token
post
Delete user token
delete
Uploads
Create upload
post
Users
List users
get
Get user
get
Update user
put
Partial update user
patch
Get my user
get
Refresh user token
post
wopi
/api/v1/wopi/files/{file_id}/accept-changes
post
Powered by
Get my user
get
https://{organization}.my.pitcher.com/api/v1/users/me/
Get details about current user.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
URL
Base URL
https://
dev
.my.pitcher.com
/api/v1/users/me/
RESPONSE
Click
Try It!
to start a request and see the response here!