Create document

curl --request POST \
  --url https://api.standardmetrics.io/v1/documents/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'company_id=<string>' \
  --form file='@example-file'

{
  "success": true,
  "message": "<string>"
}

Documents

Create document

Creates a new document in the library for a company.

Notes:

File size limit: 32 MB maximum.
Accepted file types:
- PDF files (.pdf)
- Microsoft Word documents (.docx)
- Microsoft Excel spreadsheets (.xlsx)
- Microsoft PowerPoint presentations (.pptx)
- OpenDocument spreadsheets (.ods)
- JPEG images (.jpg, .jpeg)
- PNG images (.png)
- WebP images (.webp)
- GIF images (.gif)

Permissions:

User must be authenticated via OAuth.
User must have access to the company.
User must have access to the company’s document data.

POST

documents

Create document

curl --request POST \
  --url https://api.standardmetrics.io/v1/documents/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'company_id=<string>' \
  --form file='@example-file'

{
  "success": true,
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Your valid bearer token. All Auth tokens persist for all requests. Make sure to replace Client Credential Basic tokens with Bearer tokens after retrieving your bearer token. Go to the API Reference/Setup, User Guides/Initial Setup, or API Reference/Get API Access Token page to get your token.

Body

company_id

string

required

The id for the company whose documents to request. You can get a company's id by making a request to the /companies endpoint.

file

required

The file to add. Must be sent as part of a multipart/form-data POST request. File size limit: 32 MB maximum. Accepted file types: .pdf, .docx, .xlsx, .pptx, .ods, .jpg, .jpeg, .png, .webp, .gif

Response

201 - application/json

success

boolean

required

Indicates whether the operation was successful

message

string

required

A message describing the operation result

Get documents Download document

⌘I