Get a File

GET 
https://https://euwest.api.elasticpath.com/v2/files/:fileID

Get a File

Request

Path Parameters

fileID stringrequired

The unique identifier for a file.

Responses

200

application/json

Schema

Schema

data File
iduuid
The unique identifier for this file.
Example: 00000000-0000-0000-0000-000000000000
typestring
The type represents the object being returned.
Example: file
file_namestring
The name of the file.
Example: file_name.jpg
mime_typestring
The mime type of the file.
Example: image/jpeg
file_sizeinteger
The size of the file. Required when uploading files.
Example: 36000
publicboolean
DEPRECATED Whether the file public or not. Required when uploading files.
Example: true
meta FileMeta
timestamps object
The date and time the file was created.
created_atstring
The date and time the file was created.
Example: 2023-10-11T13:02:25.293Z
dimensions object
The file dimensions.
widthinteger
The width of the file.
Example: 1800
heightinteger
The height of the file.
Example: 1000
links object
Links are used to allow you to move between requests.
selfstring
Single entities use a self parameter with a link to that specific resource.
Example: https://https://euwest.api.elasticpath.com//v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52
link object
The publicly available URL for this file.
hrefstring
The publicly available URL for this file.
Example: https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png

Example (auto)

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "file",
    "file_name": "file_name.jpg",
    "mime_type": "image/jpeg",
    "file_size": 36000,
    "public": true,
    "meta": {
      "timestamps": {
        "created_at": "2023-10-11T13:02:25.293Z"
      },
      "dimensions": {
        "width": 1800,
        "height": 1000
      }
    },
    "links": {
      "self": "https://https://euwest.api.elasticpath.com//v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52"
    },
    "link": {
      "href": "https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png"
    }
  }
}

default

{
  "data": {
    "type": "file",
    "id": "f8cf26b3-6d38-4275-937a-624a83994702",
    "link": {
      "href": "https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png"
    },
    "file_name": "f6669358-85db-4367-9cde-1deb77acb5f4.png",
    "mime_type": "image/png",
    "file_size": 110041,
    "meta": {
      "dimensions": {
        "width": 1000,
        "height": 1000
      },
      "timestamps": {
        "created_at": "2018-03-13T13:45:21.673Z"
      }
    },
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/files/f8cf26b3-6d38-4275-937a-624a83994702"
    }
  }
}

404

Forbidden. The operation is forbidden on this entity.

application/json

Schema

Schema

errors Error[]required
Array [
statusintrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
statusintrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "status": 500,
      "title": "Internal Server Error",
      "detail": "There was an internal server error, you can report with your request id.",
      "request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://https://euwest.api.elasticpath.com/v2/files/:fileID");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://https://euwest.api.elasticpath.com

Auth

Bearer Token

Parameters

fileID — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!