Skip to content

List imports

GET
/v1/tenant/assets/imports
curl --request GET \
--url 'https://api.keliplay.com/v1/tenant/assets/imports?ids=0192f3a1-0000-7000-8000-0000000f2002%2C0192f3a1-0000-7000-8000-0000000f2003' \
--header 'Authorization: Bearer <token>'

Returns the state of URL imports, newest first, up to 50. Without ids you get every import that has not finished. With ids you get those imports in any state, so you can see one finish.

Permission: assets.read.

ids
string

Comma-separated file ids, up to 20.

Example
0192f3a1-0000-7000-8000-0000000f2002,0192f3a1-0000-7000-8000-0000000f2003

The imports.

Media typeapplication/json
object
imports
required
Array<object>
<= 50 items

A file in your media library.

object
id
required
string
url
required

Where the file is served from. Use it in configs, themes and pages.

string format: uri
filename
required
string
contentType
required
string
sizeBytes

Set once the upload is confirmed.

integer | null
folderId
required
string | null
sourceUrl

The URL an imported file came from.

string | null
importStatus

Null for uploaded files.

string | null
Allowed values: pending failed done
importError
string | null
importAttempts
integer
createdAt
required
string format: date-time
updatedAt
string format: date-time
confirmedAt

When the file became available. Null while it is still uploading or importing.

string | null format: date-time
Example
{
"imports": [
{
"id": "0192f3a1-0000-7000-8000-0000000f2002",
"url": "https://cdn.example.com/media/autumn-banner.png",
"filename": "autumn-banner.png",
"contentType": "image/png",
"sizeBytes": 482113,
"folderId": "0192f3a1-0000-7000-8000-0000000f1001",
"sourceUrl": "https://www.example.com/images/autumn-banner.png",
"importStatus": "done",
"importError": null,
"importAttempts": 1,
"createdAt": "2026-10-05T10:00:00.000Z",
"updatedAt": "2026-10-05T10:00:04.000Z",
"confirmedAt": "2026-10-05T10:00:04.000Z"
}
]
}

The request is not valid. details lists each field that failed, where there is one.

Media typeapplication/json
object
error
required
object
code
required

Stable and safe to branch on.

  • invalid_request (400): the request is not valid.
  • unauthorized (401): missing, malformed or revoked API key.
  • upgrade_required (402): not in your plan, or a plan limit is reached.
  • forbidden (403): the key lacks a permission, or the action is not allowed.
  • not_found (404): nothing with that id in your account.
  • conflict (409): clashes with the current state.
  • confirmation_required (409): repeat with confirm=true. Folder deletion only.
  • rate_limited (429): wait for Retry-After seconds.
  • internal_error (500) and service_unavailable (503): try again later.
string
Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable
message
required

Written for a person. May change; do not parse it.

string
details
One of:
Array<object>
object
path
required

The failing field, dot separated, such as prize.label.

string
message
required
string
Example
{
"error": {
"code": "invalid_request",
"message": "Invalid request json.",
"details": [
{
"path": "name",
"message": "Too small, expected string to have >=1 characters"
}
]
}
}

The API key is missing, malformed or revoked.

Media typeapplication/json
object
error
required
object
code
required

Stable and safe to branch on.

  • invalid_request (400): the request is not valid.
  • unauthorized (401): missing, malformed or revoked API key.
  • upgrade_required (402): not in your plan, or a plan limit is reached.
  • forbidden (403): the key lacks a permission, or the action is not allowed.
  • not_found (404): nothing with that id in your account.
  • conflict (409): clashes with the current state.
  • confirmation_required (409): repeat with confirm=true. Folder deletion only.
  • rate_limited (429): wait for Retry-After seconds.
  • internal_error (500) and service_unavailable (503): try again later.
string
Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable
message
required

Written for a person. May change; do not parse it.

string
details
One of:
Array<object>
object
path
required

The failing field, dot separated, such as prize.label.

string
message
required
string
Example
{
"error": {
"code": "unauthorized",
"message": "Invalid or revoked API key."
}
}

The API key does not carry the permission this needs, or the request is not allowed.

Media typeapplication/json
object
error
required
object
code
required

Stable and safe to branch on.

  • invalid_request (400): the request is not valid.
  • unauthorized (401): missing, malformed or revoked API key.
  • upgrade_required (402): not in your plan, or a plan limit is reached.
  • forbidden (403): the key lacks a permission, or the action is not allowed.
  • not_found (404): nothing with that id in your account.
  • conflict (409): clashes with the current state.
  • confirmation_required (409): repeat with confirm=true. Folder deletion only.
  • rate_limited (429): wait for Retry-After seconds.
  • internal_error (500) and service_unavailable (503): try again later.
string
Allowed values: invalid_request unauthorized upgrade_required forbidden not_found conflict confirmation_required rate_limited internal_error service_unavailable
message
required

Written for a person. May change; do not parse it.

string
details
One of:
Array<object>
object
path
required

The failing field, dot separated, such as prize.label.

string
message
required
string
Example
{
"error": {
"code": "forbidden",
"message": "Your role does not allow this (draws.run)."
}
}