Skip to main content
GET
/
api
/
v1
/
reports
/
{id}
/
attachments
/
Attachments
curl --request GET \
  --url https://api.main.apexscore.ai/api/v1/reports/{id}/attachments/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "file": "<string>",
    "friendly_name": "<string>",
    "description": "<string>",
    "configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "file_extension": "<string>",
    "file_size": 123,
    "friendly_filetype": "<string>",
    "mime_type": "<string>",
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "full_name": "<string>",
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this report.

Query Parameters

​
configuration_id
string<uuid>

Optional configuration id to retrieve. If not provided, the primary configuration will be used.

​
ordering
string

Which field to use when ordering the results.

Response

200 - application/json
​
id
string<uuid>
required
​
file
string<uri>
required
​
friendly_name
string
required
​
description
string | null
required
​
configuration_id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
file_extension
string
required
​
file_size
integer
required
​
friendly_filetype
string
required

This method get_friendly_name first tries to match the MIME type to a friendly name. If the MIME type is not available or not in the predefined list, it falls back to using the file extension. You can expand the mime_to_name and ext_to_name dictionaries to include more MIME types and extensions as needed.

Returns: str: A friendly name for the file type

​
mime_type
string
required
​
created_by
object
required
⌘I