Users

Get user details

get

Update user info

put

Delete user

delete

Table Record

https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/tables/table_name/data/record_id

This endpoint enables mutating a given record in a table, referenced by its ID.

Expected parameters

NameDescriptionInRequiredSchema
db_branch_name

The DBBranchName matches the pattern `{db_name}:{branch_name}`.

pathstring
table_name

The Table name

pathstring
record_id

The Record name

pathstring
columns

Column filters

query-array

Get Record by ID

GET
https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/tables/table_name/data/record_id

Retrieve record by ID

Responses

Insert Record With ID

PUT
https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/tables/table_name/data/record_id

By default, IDs are auto-generated when data is inserted into Xata. Sending a request to this endpoint allows us to insert a record with a pre-existing ID, bypassing the default automatic ID generation.

Expected parameters

NameDescriptionInRequiredSchema
createOnly

query-boolean
ifVersion

query-integer

Request Body Type Definition

Responses

Update Record With ID

PATCH
https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/tables/table_name/data/record_id

Expected parameters

NameDescriptionInRequiredSchema
ifVersion

query-integer

Request Body Type Definition

Responses

Upsert Record With ID

POST
https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/tables/table_name/data/record_id

Expected parameters

NameDescriptionInRequiredSchema
ifVersion

query-integer

Request Body Type Definition

Responses

Delete Record From Table

DELETE
https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/tables/table_name/data/record_id

Responses