/
Retrieve files

Retrieve files

Request

Retrieves a list of files.

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

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

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.

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/files?limit=0&offset=0&filter=string&q=string&fields=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of files retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

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 file.

Example:"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"
namestring, <= 255 characters

Original file name.

extensionstring

File extension.

descriptionstring, <= 255 characters

Description of the file.

sourceTypestring or null

Source of the file.

Enum:"upload""camera""organization-export""organization-closure-export"null
Example:"upload"
tagsArray of strings

List of tags associated with the file.

mimestringread-only

MIME type of the file.

Enum:"image/png""image/jpeg""image/gif""application/pdf""application/json""application/zip""text/csv"
sizeintegerread-only

File size, in bytes.

widthinteger or nullread-only

Width of the image. This field is applicable to images only.

heightinteger or nullread-only

Height of the image. This field is applicable to images only.

sha1stringread-only

Hash sum of the file.

exifDataobject or nullread-only

Collection of EXIF tags contained in the image metadata. This field is applicable to images only.

Example:
{
  "FileSize": 120,
  "Software": "GIMP 2.4.5"
}
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.

isPublicboolean

Specifies if the file is available publicly without authentication. If this value is true, the permalink in the _links section contains the public URL.

]
Response
[
  {
    "id": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N",
    "name": "string",
    "extension": "string",
    "description": "string",
    "sourceType": "upload",
    "tags": [ … ],
    "mime": "image/png",
    "size": 0,
    "width": 0,
    "height": 0,
    "sha1": "string",
    "exifData": { … },
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "isPublic": true,
    "_links": [ … ]
  }
]