Retrieve Single Attachment

Request

Path Params

collection_id

string

required

attachment_id

string

required

Query Params

show

string

optional

limit the response to show only specific properties, see show & hide for more info

Example:

id,updated_at

hide

string

optional

hide properties from the response, see show & hide for more info

Example:

created_at,updated_at

with

array[string]

optional

object(s) included in the dataset, see eager loading for more info.

Possible options are:

collection

Allowed value:

collection

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.vplan.com/v1/collection//attachment/' \
--header 'x-api-key;' \
--header 'x-api-env;'

Responses

🟢200Ok

application/json

Body

id

string <uuid>

read-onlyoptional

Unique identifier

filename

string

optional

Filename of the attachment

file

string <uri>

optional

URI the file can be accessed on

type

enum<string>

optional

Allowed values:

fs.mostwanted.iootherFS clone

checksum

string <sha256>

optional

Checksum of the file. This checksum is a SHA-256 hash of the contents of the file.

signature

string

optional

Signature of the file, required for FS related url's, otherwise for informational purposes

bytes

integer

optional

Size of the attachment in bytes

thumbnail

string <uri>

optional

URL the thumbnail can be accessed on

WARNING

If thumbnail_type is fs.mostwanted.io the url will expire over time

thumbnail_type

enum<string>

optional

Allowed value:

fs.mostwanted.io

thumbnail_checksum

string <sha256>

optional

Checksum of the thumbnail. This checksum is a SHA-256 hash of the contents of the thumbnail.

thumbnail_signature

string

optional

Signature of the thumbnail, required for FS related url's, otherwise for informational purposes

thumbnail_bytes

integer

optional

Size of the attachment in bytes

collection_id

string <uuid>

required

Unique identifier of the Collection

user_id

string <uuid>

required

Unique identifier of the User

external_ref

string | null

read-onlyoptional

Third-party reference of the object, for informational purposes only

Example:

fb1033a2ed70

created_at

string <date-time>

read-onlyoptional

Date and time of creation

Example:

2024-04-11T10:22:15Z

updated_at

string <date-time>

read-onlyoptional

Date and time of last update

Example:

2024-04-11T10:22:15Z

Example

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filename": "string",
  "file": "http://example.com",
  "type": "fs.mostwanted.io",
  "checksum": "string",
  "signature": "string",
  "bytes": 0,
  "thumbnail": "http://example.com",
  "thumbnail_type": "fs.mostwanted.io",
  "thumbnail_checksum": "string",
  "thumbnail_signature": "string",
  "thumbnail_bytes": 0,
  "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "external_ref": "fb1033a2ed70",
  "created_at": "2024-04-11T10:22:15Z",
  "updated_at": "2024-04-11T10:22:15Z"
}

🟠404Not Found

🟠401Not Logged In