curl --request GET \
--url https://api.arcuserp.com/v1/attachments/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.arcuserp.com/v1/attachments/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.arcuserp.com/v1/attachments/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/attachments/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/attachments/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/attachments/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/attachments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "attachment",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_type": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"s3_bucket": "<string>",
"s3_key": "<string>",
"s3_etag": "<string>",
"checksum_sha256": "<string>",
"uploaded_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"uploaded_via": "web",
"is_public": false,
"expires_at": "2023-11-07T05:31:56Z",
"external_source": "<string>",
"external_id": "<string>",
"metadata": {},
"deleted_at": "2023-11-07T05:31:56Z",
"s3_deleted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Retrieve an attachment
Returns a single attachment record with its metadata and current status. Requires attachments:read scope.
curl --request GET \
--url https://api.arcuserp.com/v1/attachments/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.arcuserp.com/v1/attachments/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.arcuserp.com/v1/attachments/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/attachments/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/attachments/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/attachments/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/attachments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "attachment",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_type": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filename": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"s3_bucket": "<string>",
"s3_key": "<string>",
"s3_etag": "<string>",
"checksum_sha256": "<string>",
"uploaded_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"uploaded_via": "web",
"is_public": false,
"expires_at": "2023-11-07T05:31:56Z",
"external_source": "<string>",
"external_id": "<string>",
"metadata": {},
"deleted_at": "2023-11-07T05:31:56Z",
"s3_deleted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Authorizations
API key issued per entity via Settings > Developers > API Keys.
Each key carries scopes (e.g. orders:read, products:write).
Bearer token format: Authorization: Bearer ark_live_ent_
Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.
Path Parameters
Response
Attachment
A file attached to a parent resource via parent_type + parent_id. The two-step upload flow (POST /attachments/upload-url then POST /attachments) persists bytes in S3 and the row in public.attachments. s3_bucket and s3_key are operator-internal; clients fetch the file by minting a fresh presigned URL via POST /attachments/{id}/download-url. Soft-delete clears deleted_at but does NOT delete the S3 object; an out-of-band sweeper sets s3_deleted_at once bytes are purged. Scope: attachments:read / attachments:write / attachments:delete.
"attachment"
Parent resource family (order, account, ap_bill, etc.). 1..30 chars.
Operator-supplied file name. 1..255 chars.
Content type at upload time. 1..100 chars.
File size at upload time in bytes.
Operator-internal; clients should never need this.
Operator-internal; clients should never need this.
SHA-256 of the bytes if supplied at upload time.
Origin of the upload. Set automatically; not caller-writable.
web, api, portal, migration If true, exposes via tokenized portal URL.
Optional auto-expiry; the sweeper soft-deletes past this date.
Migration provenance (versa, bubble).
Free-form caller metadata. Default {}.
Set once the sweeper purges S3 bytes.
Was this page helpful?

