Skip to navigation

Retrieve paginated list of ATS attachment files

Lists the files attached to an ATS record, each with a time-limited download URL. Use it to read back or download documents uploaded earlier; to add a file, use POST /rest/ats/attachments/{attachable_type_slug}/{attachable_id}/{attachment_type_slug}.

Token scopes: ats:read, worker:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

attachable_type_slugenumRequired
Type of the attachable entity
attachable_idstringRequiredformat: "uuid"
Unique identifier for the attachable entity
attachment_type_slugenumRequired
Type of the attachment
Allowed values:

Query parameters

cursorstringOptional<=1000 characters
The cursor for pagination
limitintegerOptional1-100Defaults to 20
Maximum number of records returned in one response

Response

Successful operation.
datalist of objects
Array of attachment objects
has_moreboolean
Indicates if there are more results available
next_cursorstring or null<=1000 characters
Cursor for pagination to fetch next page
total_countdouble
Total count of attachments

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error