Skip to main content
GET
/
v1
/
entities
/
{entityTypeName}
/
{entityId}
/
files
List Entity Files
curl --request GET \
  --url https://api.us.lexful.app/v1/entities/{entityTypeName}/{entityId}/files \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-ID: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "original_name": "<string>",
      "file_extension": "<string>",
      "mime_type": "<string>",
      "size": 123,
      "is_public": true,
      "s3_key": "<string>",
      "upload_status": "pending",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "property_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "updated_by": "<string>",
      "data": {}
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Path Parameters

entityTypeName
string
required

Entity type name

Query Parameters

property_name
string

Filter by property name

is_public
boolean

Filter by public flag

upload_status
enum<string>

Filter by upload status

Available options:
pending,
uploading,
completed,
failed
name
string

Filter by file name

mime_type
string

Filter by MIME type

limit
number
default:100
Required range: 1 <= x <= 1000
offset
number
default:0
Required range: x >= 0

Response

Default Response

items
object[]
required
total
number
required

Total number of items available

limit
number
required

Number of items returned

offset
number
required

Number of items skipped