# List all External Links

List the previously created  for a .

For details on how to query endpoints using the available parameters, see Query Parameters.

Endpoint: GET /files/{file_id}/external_links
Version: 2022-02-01
Security: BasicAuth

## Path parameters:

  - `file_id` (string, required)
    Your  ID.

## Query parameters:

  - `after_cursor` (string)
    Return every resource created after the cursor value.

  - `limit` (integer)
    The numbers of items to return.
    Example: 3

  - `id` (string)
    Filter by .

  - `created_at.gte` (string)
    Filter where  is after the given date.
    Example: "2022-09-27T11:21:23"

  - `created_at.lte` (string)
    Filter where  is before the given date.
    Example: "2026-09-27T11:21:23"

  - `updated_at.gte` (string)
    Filter where  is after the given date.
    Example: "2022-09-27T11:21:23"

  - `updated_at.lte` (string)
    Filter where  is before the given date.
    Example: "2026-09-27T11:21:23"

  - `before_cursor` (string)
    Return every resource created before the cursor value.

## Response 200 fields (application/json):

  - `page` (object)
    Details the page that's returned.

  - `page.limit` (integer)
    The number of entries to return.

  - `page.next_cursor` (string,null)
    The cursor to use for the next page of results.

  - `_embedded` (object)
    List of  resources.

  - `_embedded.external_links` (array)
    resources.

  - `_embedded.external_links.id` (string)
    The ID of the  resource.

  - `_embedded.external_links.created_at` (string)
    Timestamp of when the object was created.

  - `_embedded.external_links.duration` (integer,null)
    Details how long (in minutes) the  is valid for.

  - `_embedded.external_links.expired` (boolean)
    true or false

  - `_embedded.external_links.expires_at` (string)
    When the external link expires

  - `_embedded.external_links.file_id` (string)
    The  ID the  relates to.

  - `_embedded.external_links.tags` (object,null)
    Include up to 50  pairs to annotate requests with custom metadata.
- Maximum character length for individual  is 40.
- Maximum character length for individual  is 500.
(For example, , , )

  - `_embedded.external_links.type` (string)
    Sets if the link is for uploading or downloading files from Finix.
    Enum: "UPLOAD", "DOWNLOAD", "VIEW"

  - `_embedded.external_links.url` (string)
    The URL that can be used to upload, download, or view the file.

  - `_embedded.external_links.user_id` (string)
    The ID of the  that requested to create this link.

  - `_links` (object)
    For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these  to make your follow-up requests and quickly access relevant IDs.

  - `_links.next` (object)
    Link to the next page of entries.

  - `_links.next.href` (string)

  - `_links.self` (object)
    Link to the resource that was used in the request.

## Response 401 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "UNKNOWN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.self` (object)

  - `_embedded.errors._links.self.href` (string)

  - `_embedded.errors._links.source` (object)

## Response 403 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "FORBIDDEN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 404 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "NOT_FOUND"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)