PocketBase

App · 19 actions

Work with the data behind your PocketBase app: search, add, update and delete records in any collection, add users and send their verification and password reset emails, get file links, and make backups. Start a workflow when a record is added or changed.

Actions

ActionWhat it does
Create backupBack up PocketBase's database and files to a zip kept on the server (or its S3 storage).
Create or update recordUpdate the record whose value in the field you match on is the one given, such as a customer with this email address, or add it if there is none, so a workflow that runs twice never adds it twice.
Create recordAdd a record to a collection, with a value for each field you fill in.
Create userAdd a user who can sign in to your app, and send them the email that asks them to verify their address.
Delete backupDelete one of PocketBase's backups, for good.
Delete recordDelete one record of a collection, for good.
Find first recordFind the first record of a collection that matches a filter, such as the customer with an email address.
Get collectionRead one collection: its fields with their types and choices, the fields a new record needs and who the API rules let in.
Get file URLsGet the addresses of the files in a record's file field, to send or download in a later step, with a thumbnail size for images.
Get recordRead one record of a collection by its ID, with its fields and any related records you expand.
List backupsList PocketBase's backups, newest first, with their sizes.
List collectionsList the collections, with each one's fields, their types and choices, the fields a new record needs and who the API rules let in.
List logsRead PocketBase's logs, newest first: every request to its API, with its answer and how long it took, and the app's own errors.
List recordsList or search the records of a collection with PocketBase's filter syntax, sorted the way you choose, with related records expanded, a page at a time.
Run batchAdd, update, add-or-replace and delete records in several collections at once: PocketBase saves all of them or, if one fails, none.
Send password reset emailEmail a user a link to choose a new password.
Send verification emailEmail a user a link to verify their email address.
Update recordChange some fields of a record.
Upload filePut a file, such as an image or a PDF, into a record's file field.

Create backup

Back up PocketBase's database and files to a zip kept on the server (or its S3 storage). Needs a superuser's connection.

Inputs

Backup namenametext
The zip's name, in lower-case letters, numbers, - and _, such as before_import.zip. Defaults to one with today's date and time.

Outputs

modifiedtext
When it was made
nametext
The backup's file name, such as nightly.zip
sizenumber
Its size in bytes
Example output
{
  "modified": "2026-11-05 10:00:00.000Z",
  "name": "lodol_20261105_100000.zip",
  "size": 239044
}

Create or update record

Update the record whose value in the field you match on is the one given, such as a customer with this email address, or add it if there is none, so a workflow that runs twice never adds it twice.

Inputs

CollectioncollectiontextRequired
The collection to work with, such as posts. Pick it from the list, or type its name (a user's connection can't list collections).
Match onmatch_fieldtextRequired
The field that tells records apart, such as email. Give its value in Fields; its values should be unique.
FieldsfieldsobjectRequired
A value for each field to fill in, including the one to match on. An existing record keeps the fields left blank. A relation field takes the related record's ID; a field that holds several choices or records takes them separated by commas.

Outputs

collectiontext
The collection it's in, such as customers
createdtrue/false
True if the record was added, false if an existing one was updated
idtext
The record's ID, 15 letters and numbers
linktext
Where to open it in the PocketBase dashboard
recordobject
The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}
Example output
{
  "collection": "customers",
  "created": true,
  "id": "e06uuqlhvxhqzyj",
  "link": "https://example.pockethost.io/_/#/collections?collection=pbc_108570809&record=e06uuqlhvxhqzyj",
  "record": {
    "collectionId": "pbc_108570809",
    "collectionName": "customers",
    "created": "2026-11-05 10:00:00.000Z",
    "email": "ada@example.com",
    "id": "e06uuqlhvxhqzyj",
    "name": "Ada Lovelace",
    "owner": "tkn8st6f7pg1ytp",
    "score": 92,
    "status": "active",
    "updated": "2026-11-05 10:00:00.000Z",
    "vip": true
  }
}

Create record

Add a record to a collection, with a value for each field you fill in.

Inputs

CollectioncollectiontextRequired
The collection to work with, such as posts. Pick it from the list, or type its name (a user's connection can't list collections).
FieldsfieldsobjectRequired
A value for each field to fill in. Fields left blank get their default. A relation field takes the related record's ID; a field that holds several choices or records takes them separated by commas.
Expand related recordsexpandtext
Relation fields whose records to include in full, separated by commas, such as owner or customer.owner. They come back under "expand".

Outputs

collectiontext
The collection it's in, such as customers
idtext
The record's ID, 15 letters and numbers
linktext
Where to open it in the PocketBase dashboard
recordobject
The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}
Example output
{
  "collection": "customers",
  "id": "e06uuqlhvxhqzyj",
  "link": "https://example.pockethost.io/_/#/collections?collection=pbc_108570809&record=e06uuqlhvxhqzyj",
  "record": {
    "collectionId": "pbc_108570809",
    "collectionName": "customers",
    "created": "2026-11-05 10:00:00.000Z",
    "email": "ada@example.com",
    "id": "e06uuqlhvxhqzyj",
    "name": "Ada Lovelace",
    "owner": "tkn8st6f7pg1ytp",
    "score": 92,
    "status": "active",
    "updated": "2026-11-05 10:00:00.000Z",
    "vip": true
  }
}

Create user

Add a user who can sign in to your app, and send them the email that asks them to verify their address.

Inputs

Users collectioncollectiontext
The auth collection the user is in. Leave it as users unless your app keeps its users in another one.Default: users.
EmailemailtextRequired
The user's email address.
PasswordpasswordtextRequired
Their first password, at least 8 characters. They can change it with a password reset.
Namenametext
Their name, if the collection has a name field.
Other fieldsfieldsobject
Values for the collection's other fields.
Mark as verifiedverifiedtrue/false
Mark their email address as already verified. Only a superuser's connection may.Default: false.
Show email to other usersemail_visibilitytrue/false
Let other users of the app see their email address.Default: false.
Send verification emailsend_verificationtrue/false
Email them a link to verify their address, unless they're marked as verified.Default: true.

Outputs

collectiontext
The collection it's in, such as customers
emailtext
The user's email address
idtext
The record's ID, 15 letters and numbers
linktext
Where to open it in the PocketBase dashboard
recordobject
The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}
verification_senttrue/false
Whether a verification email was sent
verifiedtrue/false
Whether the user's email address is verified
Example output
{
  "collection": "users",
  "email": "ada@example.com",
  "id": "tkn8st6f7pg1ytp",
  "link": "https://example.pockethost.io/_/#/collections?collection=_pb_users_auth_&record=tkn8st6f7pg1ytp",
  "record": {
    "avatar": "",
    "collectionId": "_pb_users_auth_",
    "collectionName": "users",
    "created": "2026-11-05 10:00:00.000Z",
    "email": "ada@example.com",
    "emailVisibility": false,
    "id": "tkn8st6f7pg1ytp",
    "name": "Ada Lovelace",
    "updated": "2026-11-05 10:00:00.000Z",
    "verified": false
  },
  "verification_sent": true,
  "verified": false
}

Delete backup

Delete one of PocketBase's backups, for good. Needs a superuser's connection.

Inputs

Backup namenametextRequired
The backup's file name, such as nightly_2026_11_05.zip, from List backups or Create backup.

Outputs

deletedtrue/false
True once the backup is deleted
nametext
The deleted backup's name
Example output
{
  "deleted": true,
  "name": "lodol_20261105_100000.zip"
}

Delete record

Delete one record of a collection, for good.

Inputs

CollectioncollectiontextRequired
The collection to work with, such as posts. Pick it from the list, or type its name (a user's connection can't list collections).
Record IDrecord_idtextRequired
The record's ID, 15 letters and numbers such as e06uuqlhvxhqzyj, from a trigger or another PocketBase step.

Outputs

collectiontext
The collection it was in
deletedtrue/false
True once the record is deleted
idtext
The deleted record's ID
Example output
{
  "collection": "customers",
  "deleted": true,
  "id": "e06uuqlhvxhqzyj"
}

Find first record

Find the first record of a collection that matches a filter, such as the customer with an email address. Says found is false when none matches, rather than failing.

Inputs

CollectioncollectiontextRequired
The collection to work with, such as posts. Pick it from the list, or type its name (a user's connection can't list collections).
FilterfiltertextRequired
Which record, in PocketBase's filter syntax, such as email = "ada@example.com". Text goes in quotes.
Sortsorttext
Field names to sort by, separated by commas, with - in front for newest or highest first, such as -created or status,-score.
Expand related recordsexpandtext
Relation fields whose records to include in full, separated by commas, such as owner or customer.owner. They come back under "expand".

Outputs

collectiontext
The collection it's in, such as customers
foundtrue/false
True if a record matches
idtext
The record's ID, 15 letters and numbers
linktext
Where to open it in the PocketBase dashboard
recordobject
The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}
Example output
{
  "collection": "customers",
  "found": true,
  "id": "e06uuqlhvxhqzyj",
  "link": "https://example.pockethost.io/_/#/collections?collection=pbc_108570809&record=e06uuqlhvxhqzyj",
  "record": {
    "collectionId": "pbc_108570809",
    "collectionName": "customers",
    "created": "2026-11-05 10:00:00.000Z",
    "email": "ada@example.com",
    "id": "e06uuqlhvxhqzyj",
    "name": "Ada Lovelace",
    "owner": "tkn8st6f7pg1ytp",
    "score": 92,
    "status": "active",
    "updated": "2026-11-05 10:00:00.000Z",
    "vip": true
  }
}

Get collection

Read one collection: its fields with their types and choices, the fields a new record needs and who the API rules let in. Needs a superuser's connection.

Inputs

CollectioncollectiontextRequired
The collection to work with, such as posts. Pick it from the list, or type its name (a user's connection can't list collections).

Outputs

api_rulesobject
Who may list, view, create, update and delete its records: Superusers only, Anyone, or "Where: <rule>"
created_fieldtext
The field PocketBase stamps when a record is added; empty if none
fieldslist
Its fields
file_fieldslist
Its file fields
idtext
The collection's ID
nametext
The collection's name, as steps use it, such as customers
required_fieldslist
The fields a new record must be given
systemtrue/false
Whether it's one of PocketBase's own
typetext
base, auth (has users who sign in) or view (read-only)
updated_fieldtext
The field PocketBase stamps when a record is changed; empty if none
Example output
{
  "api_rules": {
    "create": "Where: @request.auth.id != ''",
    "delete": "Superusers only",
    "list": "Where: @request.auth.id != ''",
    "update": "Superusers only",
    "view": "Where: @request.auth.id != ''"
  },
  "created_field": "created",
  "fields": [
    {
      "choices": [],
      "hidden": false,
      "multiple": false,
      "name": "id",
      "related_collection": "",
      "required": true,
      "type": "text",
      "writable": false
    },
    {
      "choices": [
        "lead",
        "active",
        "churned"
      ],
      "hidden": false,
      "multiple": false,
      "name": "status",
      "related_collection": "",
      "required": false,
      "type": "select",
      "writable": true
    }
  ],
  "file_fields": [
    "contract"
  ],
  "id": "pbc_108570809",
  "name": "customers",
  "required_fields": [
    "name"
  ],
  "system": false,
  "type": "base",
  "updated_field": "updated"
}

Get file URLs

Get the addresses of the files in a record's file field, to send or download in a later step, with a thumbnail size for images. A protected field's addresses work for a few minutes.

Inputs

CollectioncollectiontextRequired
The collection to work with, such as posts. Pick it from the list, or type its name (a user's connection can't list collections).
Record IDrecord_idtextRequired
The record's ID, 15 letters and numbers such as e06uuqlhvxhqzyj, from a trigger or another PocketBase step.
File fieldfieldtextRequired
The record's file field, such as avatar or attachments.
Thumbnail sizethumbtext
For images, a size such as 100x100 (cropped to fill), 300x0 (300 wide) or 100x100f (fitted inside). It must be one of the field's thumb sizes, or PocketBase gives the original.
Download linksdownloadtrue/false
Make the links download the file rather than open it in the browser.Default: false.

Outputs

collectiontext
The record's collection
countnumber
How many files the field holds
expires_attext
When the addresses of protected files stop working (ISO 8601); empty if not
fieldtext
The file field
fileslist
The field's files
idtext
The record's ID
protectedtrue/false
Whether the field is protected: its addresses carry a token that soon runs out
urltext
The first file's address; empty if the field has none
urlslist
The files' addresses
Example output
{
  "collection": "customers",
  "count": 1,
  "expires_at": "",
  "field": "contract",
  "files": [
    {
      "name": "contract_zxiq01yjsk.pdf",
      "url": "https://example.pockethost.io/api/files/pbc_108570809/e06uuqlhvxhqzyj/contract_zxiq01yjsk.pdf"
    }
  ],
  "id": "e06uuqlhvxhqzyj",
  "protected": false,
  "url": "https://example.pockethost.io/api/files/pbc_108570809/e06uuqlhvxhqzyj/contract_zxiq01yjsk.pdf",
  "urls": [
    "https://example.pockethost.io/api/files/pbc_108570809/e06uuqlhvxhqzyj/contract_zxiq01yjsk.pdf"
  ]
}

Get record

Read one record of a collection by its ID, with its fields and any related records you expand.

Inputs

CollectioncollectiontextRequired
The collection to work with, such as posts. Pick it from the list, or type its name (a user's connection can't list collections).
Record IDrecord_idtextRequired
The record's ID, 15 letters and numbers such as e06uuqlhvxhqzyj, from a trigger or another PocketBase step.
Expand related recordsexpandtext
Relation fields whose records to include in full, separated by commas, such as owner or customer.owner. They come back under "expand".
Fields to returnreturn_fieldslist
Return only these fields. Leave empty for all of them.

Outputs

collectiontext
The collection it's in, such as customers
idtext
The record's ID, 15 letters and numbers
linktext
Where to open it in the PocketBase dashboard
recordobject
The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}
Example output
{
  "collection": "customers",
  "id": "e06uuqlhvxhqzyj",
  "link": "https://example.pockethost.io/_/#/collections?collection=pbc_108570809&record=e06uuqlhvxhqzyj",
  "record": {
    "collectionId": "pbc_108570809",
    "collectionName": "customers",
    "created": "2026-11-05 10:00:00.000Z",
    "email": "ada@example.com",
    "id": "e06uuqlhvxhqzyj",
    "name": "Ada Lovelace",
    "owner": "tkn8st6f7pg1ytp",
    "score": 92,
    "status": "active",
    "updated": "2026-11-05 10:00:00.000Z",
    "vip": true
  }
}

List backups

List PocketBase's backups, newest first, with their sizes. Needs a superuser's connection.

Inputs

None.

Outputs

backupslist
The backups, newest first
countnumber
How many backups there are
nameslist
Their names
Example output
{
  "backups": [
    {
      "modified": "2026-11-05 10:00:00.000Z",
      "name": "lodol_20261105_100000.zip",
      "size": 239044
    }
  ],
  "count": 1,
  "names": [
    "lodol_20261105_100000.zip"
  ]
}

List collections

List the collections, with each one's fields, their types and choices, the fields a new record needs and who the API rules let in. Needs a superuser's connection.

Inputs

Include PocketBase's owninclude_systemtrue/false
Also list PocketBase's own collections, such as _superusers.Default: false.

Outputs

collectionslist
The collections
countnumber
How many collections there are
nameslist
Their names
Example output
{
  "collections": [
    {
      "api_rules": {
        "create": "Where: @request.auth.id != ''",
        "delete": "Superusers only",
        "list": "Where: @request.auth.id != ''",
        "update": "Superusers only",
        "view": "Where: @request.auth.id != ''"
      },
      "created_field": "created",
      "fields": [
        {
          "choices": [],
          "hidden": false,
          "multiple": false,
          "name": "id",
          "related_collection": "",
          "required": true,
          "type": "text",
          "writable": false
        },
        {
          "choices": [
            "lead",
            "active",
            "churned"
          ],
          "hidden": false,
          "multiple": false,
          "name": "status",
          "related_collection": "",
          "required": false,
          "type": "select",
          "writable": true
        }
      ],
      "file_fields": [
        "contract"
      ],
      "id": "pbc_108570809",
      "name": "customers",
      "required_fields": [
        "name"
      ],
      "system": false,
      "type": "base",
      "updated_field": "updated"
    }
  ],
  "count": 1,
  "names": [
    "customers"
  ]
}

List logs

Read PocketBase's logs, newest first: every request to its API, with its answer and how long it took, and the app's own errors. Needs a superuser's connection.

Inputs

Filterfiltertext
Which entries, in PocketBase's filter syntax, such as data.status >= 400 or data.url ~ "/api/collections/orders".
Levelmin_leveltext
Which entries to list, by how serious they are.One of: all (Everything), warning (Warnings and errors), error (Errors only). Default: all.
Pagepagenumber
Which page of results to return, starting at 1.At least 1.
How manyper_pagenumber
The most entries to return, up to 1000. Defaults to 50.From 1 to 1000.

Outputs

countnumber
How many entries are listed
logslist
The log entries, newest first
pagenumber
Which page this is, starting at 1
total_itemsnumber
How many entries match in all
Example output
{
  "count": 1,
  "logs": [
    {
      "auth": "users",
      "created": "2026-11-05 10:00:00.000Z",
      "data": {
        "method": "POST",
        "status": 400
      },
      "error": "Failed to create record.",
      "exec_time_ms": 0.74,
      "id": "i1tnj71l9s3g571",
      "level": 8,
      "level_name": "error",
      "message": "POST /api/collections/customers/records",
      "method": "POST",
      "status": 400,
      "url": "/api/collections/customers/records",
      "user_agent": "Mozilla/5.0",
      "user_ip": "203.0.113.7"
    }
  ],
  "page": 1,
  "total_items": 1
}

List records

List or search the records of a collection with PocketBase's filter syntax, sorted the way you choose, with related records expanded, a page at a time.

Inputs

CollectioncollectiontextRequired
The collection to work with, such as posts. Pick it from the list, or type its name (a user's connection can't list collections).
Filterfiltertext
Which records, in PocketBase's filter syntax, as the dashboard's search box takes it: status = "active" && score > 50, or email ~ "@example.com" (~ means contains). Text goes in quotes.
Sortsorttext
Field names to sort by, separated by commas, with - in front for newest or highest first, such as -created or status,-score.
Expand related recordsexpandtext
Relation fields whose records to include in full, separated by commas, such as owner or customer.owner. They come back under "expand".
Fields to returnreturn_fieldslist
Return only these fields. Leave empty for all of them.
Pagepagenumber
Which page of results to return, starting at 1.At least 1.
How manyper_pagenumber
The most records to return, up to 1000. Defaults to 50.From 1 to 1000.

Outputs

collectiontext
The collection searched
countnumber
How many records are listed
idslist
The IDs of the records listed
pagenumber
Which page this is, starting at 1
recordslist
The records that match, each with its fields by name
total_itemsnumber
How many records match in all, across every page
total_pagesnumber
How many pages there are
Example output
{
  "collection": "customers",
  "count": 1,
  "ids": [
    "e06uuqlhvxhqzyj"
  ],
  "page": 1,
  "records": [
    {
      "collectionId": "pbc_108570809",
      "collectionName": "customers",
      "created": "2026-11-05 10:00:00.000Z",
      "email": "ada@example.com",
      "id": "e06uuqlhvxhqzyj",
      "name": "Ada Lovelace",
      "owner": "tkn8st6f7pg1ytp",
      "score": 92,
      "status": "active",
      "updated": "2026-11-05 10:00:00.000Z",
      "vip": true
    }
  ],
  "total_items": 1,
  "total_pages": 1
}

Run batch

Add, update, add-or-replace and delete records in several collections at once: PocketBase saves all of them or, if one fails, none. A superuser turns this on first, under Settings > Application > Batch Web API.

Inputs

OperationsoperationslistRequired
A JSON list of up to 50 operations, run in order. Each has an action (create, update, upsert or delete), a collection, the record's id (for update and delete, and upsert, which updates the record with that ID or adds it), and fields: [{"action": "create", "collection": "posts", "fields": {"title": "Hello"}}, {"action": "delete", "collection": "posts", "id": "e06uuqlhvxhqzyj"}]

Outputs

countnumber
How many operations ran
idslist
The records' IDs, in the order given
resultslist
One result per operation, in the order given
Example output
{
  "count": 1,
  "ids": [
    "e06uuqlhvxhqzyj"
  ],
  "results": [
    {
      "action": "create",
      "collection": "customers",
      "id": "e06uuqlhvxhqzyj",
      "record": {
        "collectionId": "pbc_108570809",
        "collectionName": "customers",
        "created": "2026-11-05 10:00:00.000Z",
        "email": "ada@example.com",
        "id": "e06uuqlhvxhqzyj",
        "name": "Ada Lovelace",
        "owner": "tkn8st6f7pg1ytp",
        "score": 92,
        "status": "active",
        "updated": "2026-11-05 10:00:00.000Z",
        "vip": true
      },
      "status": 200
    }
  ]
}

Send password reset email

Email a user a link to choose a new password. PocketBase sends it only if the address belongs to a user, and says nothing either way.

Inputs

Users collectioncollectiontext
The auth collection the user is in. Leave it as users unless your app keeps its users in another one.Default: users.
EmailemailtextRequired
The user's email address.

Outputs

collectiontext
The auth collection
emailtext
The email address
requestedtrue/false
True once PocketBase took the request; it emails only an address that belongs to a user
Example output
{
  "collection": "users",
  "email": "ada@example.com",
  "requested": true
}

Send verification email

Email a user a link to verify their email address. PocketBase sends it only to a user who isn't verified yet.

Inputs

Users collectioncollectiontext
The auth collection the user is in. Leave it as users unless your app keeps its users in another one.Default: users.
EmailemailtextRequired
The user's email address.

Outputs

collectiontext
The auth collection
emailtext
The email address
requestedtrue/false
True once PocketBase took the request; it emails only an address that belongs to a user
Example output
{
  "collection": "users",
  "email": "ada@example.com",
  "requested": true
}

Update record

Change some fields of a record. Fields left blank keep their value.

Inputs

CollectioncollectiontextRequired
The collection to work with, such as posts. Pick it from the list, or type its name (a user's connection can't list collections).
Record IDrecord_idtextRequired
The record's ID, 15 letters and numbers such as e06uuqlhvxhqzyj, from a trigger or another PocketBase step.
FieldsfieldsobjectRequired
The new value for each field to change. Fields left blank keep their value. A relation field takes the related record's ID; a field that holds several choices or records takes them separated by commas.
Expand related recordsexpandtext
Relation fields whose records to include in full, separated by commas, such as owner or customer.owner. They come back under "expand".

Outputs

collectiontext
The collection it's in, such as customers
idtext
The record's ID, 15 letters and numbers
linktext
Where to open it in the PocketBase dashboard
recordobject
The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}
Example output
{
  "collection": "customers",
  "id": "e06uuqlhvxhqzyj",
  "link": "https://example.pockethost.io/_/#/collections?collection=pbc_108570809&record=e06uuqlhvxhqzyj",
  "record": {
    "collectionId": "pbc_108570809",
    "collectionName": "customers",
    "created": "2026-11-05 10:00:00.000Z",
    "email": "ada@example.com",
    "id": "e06uuqlhvxhqzyj",
    "name": "Ada Lovelace",
    "owner": "tkn8st6f7pg1ytp",
    "score": 92,
    "status": "active",
    "updated": "2026-11-05 10:00:00.000Z",
    "vip": true
  }
}

Upload file

Put a file, such as an image or a PDF, into a record's file field. A field that holds several files gets it added to the others.

Inputs

CollectioncollectiontextRequired
The collection to work with, such as posts. Pick it from the list, or type its name (a user's connection can't list collections).
Record IDrecord_idtextRequired
The record's ID, 15 letters and numbers such as e06uuqlhvxhqzyj, from a trigger or another PocketBase step.
File fieldfieldtextRequired
The record's file field, such as avatar or attachments.
FilefiletextRequired
The file: upload one, pick one from an earlier step, or give a public https link to download.
Replace the field's filesreplacetrue/false
Remove the files already in the field, rather than add this one to them. A field that holds one file is always replaced.Default: false.

Outputs

collectiontext
The collection it's in, such as customers
fieldtext
The file field
file_nametext
The new file's name, as PocketBase stored it
fileslist
Every file the field holds now
idtext
The record's ID, 15 letters and numbers
linktext
Where to open it in the PocketBase dashboard
recordobject
The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}
urltext
The new file's address
Example output
{
  "collection": "customers",
  "field": "contract",
  "file_name": "contract_zxiq01yjsk.pdf",
  "files": [
    "contract_zxiq01yjsk.pdf"
  ],
  "id": "e06uuqlhvxhqzyj",
  "link": "https://example.pockethost.io/_/#/collections?collection=pbc_108570809&record=e06uuqlhvxhqzyj",
  "record": {
    "collectionId": "pbc_108570809",
    "collectionName": "customers",
    "contract": "contract_zxiq01yjsk.pdf",
    "created": "2026-11-05 10:00:00.000Z",
    "email": "ada@example.com",
    "id": "e06uuqlhvxhqzyj",
    "name": "Ada Lovelace",
    "owner": "tkn8st6f7pg1ytp",
    "score": 92,
    "status": "active",
    "updated": "2026-11-05 10:00:00.000Z",
    "vip": true
  },
  "url": "https://example.pockethost.io/api/files/pbc_108570809/e06uuqlhvxhqzyj/contract_zxiq01yjsk.pdf"
}

On this page