Files

Use the file entity to store files and related metadata. Files can be sorted by size, MIME-type, user-defined tags, and description.

The following methods are available to upload files: multipart/form-data encoded form, RAW POST — by sending the file contents as the POST body, and fetching from URL — by providing the file URL using the 'url' parameter.

Use the attachments entity to link a file to one or multiple objects, such as: customer, dispute, transaction, order, plan, product, invoice, or timeline comment. Attachments enable you to quickly find and use files related to specific entities.

Operations

Retrieve attachments

Request

Retrieves a list of attachments. You may sort attachments by: id, name, relatedId, relatedType, fileId, createdTime, and updatedTime.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

qstring

Use this field to perform a partial search of text fields.

expandstring

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Embedded resources.

fieldsstring

Limits the returned fields to the specified list, each field separated by a comma. The ID value is always returned.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/attachments?limit=1000&offset=1000&filter=string&q=string&expand=string&fields=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of attachments retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the attachment.

Example:"att_0YV7J787J0DW0918MQQMDHWA7M"
fileIdstring, <= 50 charactersrequired

ID of the linked file object.

Example:"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"
relatedTypestringrequired

Linked object type.

Enum:"customer""customer-timeline-comment""dispute""gateway-timeline-comment""invoice""invoice-timeline-comment""order-timeline-comment""organization""payment""plan"
relatedIdstringrequired

ID of the linked object.

namestring

Name of original attachment.

descriptionstring

Description of the attachment.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

]
Response
[
  {
    "id": "att_0YV7J787J0DW0918MQQMDHWA7M",
    "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N",
    "relatedType": "customer",
    "relatedId": "string",
    "name": "string",
    "description": "string",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ],
    "_embedded": { … }
  }
]