# PocketBase

> 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.

App · 19 actions. Web page: https://docs.lodol.com/docs/integrations/pocketbase

## Actions

### 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 name (`name`, text): 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**

- `modified` (text): When it was made
- `name` (text): The backup's file name, such as nightly.zip
- `size` (number): Its size in bytes

**Example output**

```json
{
  "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**

- Collection (`collection`, text, required): 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 on (`match_field`, text, required): The field that tells records apart, such as email. Give its value in Fields; its values should be unique.
- Fields (`fields`, object, required): 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**

- `collection` (text): The collection it's in, such as customers
- `created` (true/false): True if the record was added, false if an existing one was updated
- `id` (text): The record's ID, 15 letters and numbers
- `link` (text): Where to open it in the PocketBase dashboard
- `record` (object): The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}

**Example output**

```json
{
  "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**

- Collection (`collection`, text, required): 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).
- Fields (`fields`, object, required): 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 records (`expand`, text): Relation fields whose records to include in full, separated by commas, such as owner or customer.owner. They come back under "expand".

**Outputs**

- `collection` (text): The collection it's in, such as customers
- `id` (text): The record's ID, 15 letters and numbers
- `link` (text): Where to open it in the PocketBase dashboard
- `record` (object): The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}

**Example output**

```json
{
  "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 collection (`collection`, text): The auth collection the user is in. Leave it as users unless your app keeps its users in another one. Default: `users`.
- Email (`email`, text, required): The user's email address.
- Password (`password`, text, required): Their first password, at least 8 characters. They can change it with a password reset.
- Name (`name`, text): Their name, if the collection has a name field.
- Other fields (`fields`, object): Values for the collection's other fields.
- Mark as verified (`verified`, true/false): Mark their email address as already verified. Only a superuser's connection may. Default: `false`.
- Show email to other users (`email_visibility`, true/false): Let other users of the app see their email address. Default: `false`.
- Send verification email (`send_verification`, true/false): Email them a link to verify their address, unless they're marked as verified. Default: `true`.

**Outputs**

- `collection` (text): The collection it's in, such as customers
- `email` (text): The user's email address
- `id` (text): The record's ID, 15 letters and numbers
- `link` (text): Where to open it in the PocketBase dashboard
- `record` (object): The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}
- `verification_sent` (true/false): Whether a verification email was sent
- `verified` (true/false): Whether the user's email address is verified

**Example output**

```json
{
  "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 name (`name`, text, required): The backup's file name, such as nightly_2026_11_05.zip, from List backups or Create backup.

**Outputs**

- `deleted` (true/false): True once the backup is deleted
- `name` (text): The deleted backup's name

**Example output**

```json
{
  "deleted": true,
  "name": "lodol_20261105_100000.zip"
}
```

### Delete record

Delete one record of a collection, for good.

**Inputs**

- Collection (`collection`, text, required): 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 ID (`record_id`, text, required): The record's ID, 15 letters and numbers such as e06uuqlhvxhqzyj, from a trigger or another PocketBase step.

**Outputs**

- `collection` (text): The collection it was in
- `deleted` (true/false): True once the record is deleted
- `id` (text): The deleted record's ID

**Example output**

```json
{
  "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**

- Collection (`collection`, text, required): 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).
- Filter (`filter`, text, required): Which record, in PocketBase's filter syntax, such as email = "ada@example.com". Text goes in quotes.
- Sort (`sort`, text): Field names to sort by, separated by commas, with - in front for newest or highest first, such as -created or status,-score.
- Expand related records (`expand`, text): Relation fields whose records to include in full, separated by commas, such as owner or customer.owner. They come back under "expand".

**Outputs**

- `collection` (text): The collection it's in, such as customers
- `found` (true/false): True if a record matches
- `id` (text): The record's ID, 15 letters and numbers
- `link` (text): Where to open it in the PocketBase dashboard
- `record` (object): The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}

**Example output**

```json
{
  "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**

- Collection (`collection`, text, required): 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_rules` (object): Who may list, view, create, update and delete its records: Superusers only, Anyone, or "Where: <rule>"
- `created_field` (text): The field PocketBase stamps when a record is added; empty if none
- `fields` (list): Its fields
- `file_fields` (list): Its file fields
- `id` (text): The collection's ID
- `name` (text): The collection's name, as steps use it, such as customers
- `required_fields` (list): The fields a new record must be given
- `system` (true/false): Whether it's one of PocketBase's own
- `type` (text): base, auth (has users who sign in) or view (read-only)
- `updated_field` (text): The field PocketBase stamps when a record is changed; empty if none

**Example output**

```json
{
  "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**

- Collection (`collection`, text, required): 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 ID (`record_id`, text, required): The record's ID, 15 letters and numbers such as e06uuqlhvxhqzyj, from a trigger or another PocketBase step.
- File field (`field`, text, required): The record's file field, such as avatar or attachments.
- Thumbnail size (`thumb`, text): 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 links (`download`, true/false): Make the links download the file rather than open it in the browser. Default: `false`.

**Outputs**

- `collection` (text): The record's collection
- `count` (number): How many files the field holds
- `expires_at` (text): When the addresses of protected files stop working (ISO 8601); empty if not
- `field` (text): The file field
- `files` (list): The field's files
- `id` (text): The record's ID
- `protected` (true/false): Whether the field is protected: its addresses carry a token that soon runs out
- `url` (text): The first file's address; empty if the field has none
- `urls` (list): The files' addresses

**Example output**

```json
{
  "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**

- Collection (`collection`, text, required): 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 ID (`record_id`, text, required): The record's ID, 15 letters and numbers such as e06uuqlhvxhqzyj, from a trigger or another PocketBase step.
- Expand related records (`expand`, text): Relation fields whose records to include in full, separated by commas, such as owner or customer.owner. They come back under "expand".
- Fields to return (`return_fields`, list): Return only these fields. Leave empty for all of them.

**Outputs**

- `collection` (text): The collection it's in, such as customers
- `id` (text): The record's ID, 15 letters and numbers
- `link` (text): Where to open it in the PocketBase dashboard
- `record` (object): The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}

**Example output**

```json
{
  "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**

- `backups` (list): The backups, newest first
- `count` (number): How many backups there are
- `names` (list): Their names

**Example output**

```json
{
  "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 own (`include_system`, true/false): Also list PocketBase's own collections, such as _superusers. Default: `false`.

**Outputs**

- `collections` (list): The collections
- `count` (number): How many collections there are
- `names` (list): Their names

**Example output**

```json
{
  "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**

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

**Outputs**

- `count` (number): How many entries are listed
- `logs` (list): The log entries, newest first
- `page` (number): Which page this is, starting at 1
- `total_items` (number): How many entries match in all

**Example output**

```json
{
  "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**

- Collection (`collection`, text, required): 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).
- Filter (`filter`, text): 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.
- Sort (`sort`, text): Field names to sort by, separated by commas, with - in front for newest or highest first, such as -created or status,-score.
- Expand related records (`expand`, text): Relation fields whose records to include in full, separated by commas, such as owner or customer.owner. They come back under "expand".
- Fields to return (`return_fields`, list): Return only these fields. Leave empty for all of them.
- Page (`page`, number): Which page of results to return, starting at 1. At least 1.
- How many (`per_page`, number): The most records to return, up to 1000. Defaults to 50. From 1 to 1000.

**Outputs**

- `collection` (text): The collection searched
- `count` (number): How many records are listed
- `ids` (list): The IDs of the records listed
- `page` (number): Which page this is, starting at 1
- `records` (list): The records that match, each with its fields by name
- `total_items` (number): How many records match in all, across every page
- `total_pages` (number): How many pages there are

**Example output**

```json
{
  "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**

- Operations (`operations`, list, required): 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**

- `count` (number): How many operations ran
- `ids` (list): The records' IDs, in the order given
- `results` (list): One result per operation, in the order given

**Example output**

```json
{
  "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 collection (`collection`, text): The auth collection the user is in. Leave it as users unless your app keeps its users in another one. Default: `users`.
- Email (`email`, text, required): The user's email address.

**Outputs**

- `collection` (text): The auth collection
- `email` (text): The email address
- `requested` (true/false): True once PocketBase took the request; it emails only an address that belongs to a user

**Example output**

```json
{
  "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 collection (`collection`, text): The auth collection the user is in. Leave it as users unless your app keeps its users in another one. Default: `users`.
- Email (`email`, text, required): The user's email address.

**Outputs**

- `collection` (text): The auth collection
- `email` (text): The email address
- `requested` (true/false): True once PocketBase took the request; it emails only an address that belongs to a user

**Example output**

```json
{
  "collection": "users",
  "email": "ada@example.com",
  "requested": true
}
```

### Update record

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

**Inputs**

- Collection (`collection`, text, required): 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 ID (`record_id`, text, required): The record's ID, 15 letters and numbers such as e06uuqlhvxhqzyj, from a trigger or another PocketBase step.
- Fields (`fields`, object, required): 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 records (`expand`, text): Relation fields whose records to include in full, separated by commas, such as owner or customer.owner. They come back under "expand".

**Outputs**

- `collection` (text): The collection it's in, such as customers
- `id` (text): The record's ID, 15 letters and numbers
- `link` (text): Where to open it in the PocketBase dashboard
- `record` (object): The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}

**Example output**

```json
{
  "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**

- Collection (`collection`, text, required): 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 ID (`record_id`, text, required): The record's ID, 15 letters and numbers such as e06uuqlhvxhqzyj, from a trigger or another PocketBase step.
- File field (`field`, text, required): The record's file field, such as avatar or attachments.
- File (`file`, text, required): The file: upload one, pick one from an earlier step, or give a public https link to download.
- Replace the field's files (`replace`, true/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**

- `collection` (text): The collection it's in, such as customers
- `field` (text): The file field
- `file_name` (text): The new file's name, as PocketBase stored it
- `files` (list): Every file the field holds now
- `id` (text): The record's ID, 15 letters and numbers
- `link` (text): Where to open it in the PocketBase dashboard
- `record` (object): The record's fields and values, by field name, with expanded related records under "expand", such as {"id": "e06uuqlhvxhqzyj", "name": "Ada"}
- `url` (text): The new file's address

**Example output**

```json
{
  "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"
}
```
