Apps

Your organization's apps and the records in them.

GET/v1/apps

List apps

Published apps built in PlaybookOps that you can open.

Needs apps:readMCP tool list_apps

Response

  • datalist of AppRequired
curl "https://developers.playbookops.ai/v1/apps" \
  -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY"
Response · 200
{
  "data": [
    {
      "id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
      "name": "Ana Ruiz",
      "description": "Confirm the date and ask about parking.",
      "url": "https://app.playbookops.ai/…"
    }
  ]
}
GET/v1/apps/{app_id}

Get an app

One app with its collections (tables) and their fields, so you know what to ask for.

Needs apps:readMCP tool get_app

Path parameters

  • app_idstringRequired

Response

  • idstringRequired
  • namestringRequired
  • descriptionstring or null
  • urlstringRequired
  • collectionslist of AppCollectionRequired
curl "https://developers.playbookops.ai/v1/apps/APP_ID" \
  -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY"
Response · 200
{
  "id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
  "name": "Ana Ruiz",
  "description": "Confirm the date and ask about parking.",
  "url": "https://app.playbookops.ai/…",
  "collections": [
    {
      "name": "Ana Ruiz",
      "display_field": "…",
      "fields": [
        {
          "name": null,
          "type": null,
          "required": false,
          "options": null,
          "links_to": null,
          "many": false
        }
      ]
    }
  ]
}
GET/v1/apps/{app_id}/collections/{collection}/records/{record_id}

Get an app record

One Live record from an app's collection.

Needs apps:readMCP tool get_app_record

Path parameters

  • app_idstringRequired
  • collectionstringRequired
  • record_idstringRequired

Response

  • idstringRequired
  • collectionstringRequired
  • dataobjectRequired
  • created_atstring (date and time) or null
  • updated_atstring (date and time) or null
curl "https://developers.playbookops.ai/v1/apps/APP_ID/collections/COLLECTION/records/RECORD_ID" \
  -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY"
Response · 200
{
  "id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
  "collection": "…",
  "data": {},
  "created_at": "2026-11-21T15:04:05Z",
  "updated_at": "2026-11-21T15:04:05Z"
}
GET/v1/apps/{app_id}/collections/{collection}/records

List an app's records

Live records in one of an app's collections. Filter by field (eq, neq, gt, lt, in, contains, has), sort, and page with offset.

Needs apps:readMCP tool list_app_records

Path parameters

  • app_idstringRequired
  • collectionstringRequired

Query parameters

  • filterlist of string

    Repeat for each filter, as field:op:value, like status:eq:open or amount:gt:100. Ops: eq, neq, gt, lt, in, contains, has.

    Default [].

  • sortstring or null

    A field to sort by; start it with - for largest or latest first

  • offsetinteger

    At least 0, default 0.

  • limitinteger

    1–100, default 50.

Response

  • has_morebooleanRequired

    More results after these; ask again with offset=next_offset

  • next_offsetinteger or null
  • datalist of AppRecordRequired
curl "https://developers.playbookops.ai/v1/apps/APP_ID/collections/COLLECTION/records?limit=10" \
  -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY"
Response · 200
{
  "has_more": false,
  "next_offset": 0,
  "data": [
    {
      "id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
      "collection": "…",
      "data": {},
      "created_at": "2026-11-21T15:04:05Z",
      "updated_at": "2026-11-21T15:04:05Z"
    }
  ]
}
POST/v1/apps/{app_id}/collections/{collection}/records

Create an app record

Add a Live record to one of an app's collections. Fields are checked against the app like in the app itself.

Needs apps:writeChanges data · supports Idempotency-KeyMCP tool create_app_record

Path parameters

  • app_idstringRequired
  • collectionstringRequired

Body

  • dataobjectRequired

    The record's fields by name, as listed by get_app. Fields starting with _ are reserved.

Response

  • idstringRequired
  • collectionstringRequired
  • dataobjectRequired
  • created_atstring (date and time) or null
  • updated_atstring (date and time) or null
curl -X POST "https://developers.playbookops.ai/v1/apps/APP_ID/collections/COLLECTION/records" \
  -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "data": {}
}'
Response · 201
{
  "id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
  "collection": "…",
  "data": {},
  "created_at": "2026-11-21T15:04:05Z",
  "updated_at": "2026-11-21T15:04:05Z"
}
PATCH/v1/apps/{app_id}/collections/{collection}/records/{record_id}

Update an app record

Change some fields on a Live app record. Fields you leave out stay as they are.

Needs apps:writeChanges data · supports Idempotency-KeyMCP tool update_app_record

Path parameters

  • app_idstringRequired
  • collectionstringRequired
  • record_idstringRequired

Body

  • dataobjectRequired

    Only the fields to change; null clears one. The record's fields by name, as listed by get_app. Fields starting with _ are reserved.

Response

  • idstringRequired
  • collectionstringRequired
  • dataobjectRequired
  • created_atstring (date and time) or null
  • updated_atstring (date and time) or null
curl -X PATCH "https://developers.playbookops.ai/v1/apps/APP_ID/collections/COLLECTION/records/RECORD_ID" \
  -H "Authorization: Bearer $PLAYBOOKOPS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "data": {}
}'
Response · 200
{
  "id": "6f1d2c1e-8a3b-4b8e-9d55-2c0f9e7a1b42",
  "collection": "…",
  "data": {},
  "created_at": "2026-11-21T15:04:05Z",
  "updated_at": "2026-11-21T15:04:05Z"
}