Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

/file/document/types

This action returns a list of document types.

Request

curl -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     https://ppw.web/svc/file/document/types

Response

FieldDescriptionType
document_typesDocument typesobject

The value of the document_types field is a JSON object containing all the document types. In this JSON object, the key is the canonical name for the document type and value is the human readable name for the document type.

Example successful response:

{
  "document_types": {
    "1": "PDF",
    "2": "Photo"
  }
}

Errors

Error TypeDescriptionStatus Code
access_deniedAccess token is invalid or expired401
scope_invalidClient app does not have the required OAuth scope403