Developer docs menu

API reference / Documents

Documents API

4 endpoints. Scopes: Scalar360.documents.READ, .CREATE, .UPDATE, .DELETE or .ALL. All calls need Authorization: Scalar360-oauthtoken <access_token> — see Authentication.

GET

Draft

/api/v1/documents/{kind}/{gid}/email

Scope: Scalar360.documents.READ

ParameterInTypeRequired
kindpathstringYes
gidpathstring (uuid)Yes
Example request
curl -X GET "https://api.scalar360.com/api/v1/documents/{kind}/{gid}/email" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"
POST

Send

/api/v1/documents/{kind}/{gid}/email

Scope: Scalar360.documents.CREATE

ParameterInTypeRequired
kindpathstringYes
gidpathstring (uuid)Yes
Example request
curl -X POST "https://api.scalar360.com/api/v1/documents/{kind}/{gid}/email" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
GET

History

/api/v1/documents/{kind}/{gid}/emails

Scope: Scalar360.documents.READ

ParameterInTypeRequired
kindpathstringYes
gidpathstring (uuid)Yes
Example request
curl -X GET "https://api.scalar360.com/api/v1/documents/{kind}/{gid}/emails" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"
GET

Pdf

/api/v1/documents/{kind}/{gid}/pdf

Scope: Scalar360.documents.READ

ParameterInTypeRequired
kindpathstringYes
gidpathstring (uuid)Yes
Example request
curl -X GET "https://api.scalar360.com/api/v1/documents/{kind}/{gid}/pdf" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"