List Attachments

GET /attachments

Retrieve a paginated collection of Attachment records belonging to your Organization

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Query parameters

  • page integer

    Page number of the results to fetch.

    Default value is 1.

  • page_size integer

    Results per page (max 50)

    Default value is 20.

Responses

  • 200 application/json

    A collection of Attachment records

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • items array[object]
      Hide items attributes Show items attributes object
      • created_at string
      • id integer
      • request_id string | null

        The string ID of the request resource associated to an upload via this attachment. Null if this attachment associate a shipment

      • shipment_id string | null

        The string ID of the shipment resource associated to an upload via this attachment. Null if this attachment associate a request

      • updated_at string
      • upload_id integer Required

        The integer ID of the Upload resource associated with either a shipment or request via this attachment

    • metadata object

      Additional properties are allowed.

      Hide metadata attributes Show metadata attributes object
GET /attachments 
curl \
 -X GET https://api.arta.io/attachments \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200) 
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "items": [
    {
      "id": 1942,
      "upload_id": 4791,
      "created_at": "2021-10-27T16:48:38.657228",
      "request_id": "506d79b6-1e5e-4e8c-a266-74658fdaf4ee",
      "updated_at": "2021-10-27T16:48:38.657228",
      "shipment_id": null
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "total_count": 1
  }
}