Skip to main content
POST
Import entity records from CSV

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app that owns the entity.

entity_name
string
required

Name of the entity, exactly as List entity schemas reports it. Don't pass User here. It doesn't fail, but it reads and writes a separate, disconnected set of records stored under that name, not the app's real user accounts, which are managed through their own endpoints.

Body

multipart/form-data
file
file
required

The CSV file to import, with a header row naming each column. Up to 10 MB.

Response

The import's outcome, including when the file couldn't be imported.

The outcome of a CSV import.

status
enum<string>
required

Whether the import went through. Either "success" or "error". On error no records were created.

Available options:
success,
error
Example:

"success"

details
string | null
required

What happened, in plain language. On error it says why the file couldn't be imported, for example a required field no column matched.

Example:

"Successfully imported 2 entities with RLS enforcement"

output
EntityRecord · object[] | null
required

The records the import created, in the same shape as List entity records returns them, or null when status is error.

Example: