Class Manager
GET /v1/files/{id}

Get File

Path parameters

  • id string Required

    File id

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      File ID

    • companyId string Required

      Company ID

    • entityId string Required

      Entity ID

    • name string Required

      Name

    • purpose string Required

      Values are profile_picture, email_attachment, email_image, class_image, company_logo, or product_image.

    • url string Required

      Url
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
GET /v1/files/{id} 
curl \
 --request GET 'https://localhost/v1/files/file_xxxxxxxx'
Response examples (200) 
{
  "id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "companyId": "co_xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "entityId": "stf_123123123123",
  "name": "image.jpg",
  "purpose": "profile_picture",
  "url": "https://example.com/image.jpg"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}