Skip to content
Docs
Select language:English

/api/v1/paperless-links (POST)

POST
/api/v1/paperless-links
curl --request POST \
  --url https://example.com/api/v1/paperless-links \
  --header 'Content-Type: application/json' \
  --data '{ "thingId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "placeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "documentIds": [ 1 ] }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
thingId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
placeId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
documentIds
required
Array<integer>
>= 1 items <= 20 items
Examplegenerated
{
  "thingId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "placeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "documentIds": [
    1
  ]
}

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
documentId
required
integer
>= -9007199254740991 <= 9007199254740991
subject
required
Any of:
object
thingId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
title
required
string
kind
required
string
Allowed values: receipt invoice manual warranty_doc document
typeName
required
string | null
correspondent
required
string | null
createdOn
required
string | null
copiedAttachmentId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
openUrl
required
string
createdBy
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
displayName
required
string
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
Example
{
  "items": [
    {
      "kind": "receipt"
    }
  ]
}