File Objects

Get File Data

GET /(company_code)/v2/aol/file/(file_id)

Get File data

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Parameters:
  • file_id – ID of file to get (integer), or comma-separated list of IDs (FILE_ID_1,FILE_ID_2,...)
Response JSON Object:
 
  • status (string) – success or error
  • data (object) – File data objects (object field names are file IDs as strings)
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound

See Error Codes for details.