Services

List services

Returns the sellable services of the catalogue, cursor-paginated: personnel, transport and work days that do not come from inventory, with their requirements and tags.

Tool
filmo_services_list
Access: Read

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_services_list",
    "arguments": {
      "limit": 20
    }
  }
}

generated from the schema

Filter by type, collection and a single tag. Sorted by name; sort accepts a single field. Costs and the internal name are not published; creation and update date filters are not available on this listing.

Arguments

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

sortstring

Sort order: a single field, with a leading "-" for descending (e.g. "-updatedAt"). Sortable fields: name, serviceType, defaultQty, createdAt, updatedAt. Defaults to "name". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.

Limits: max length 200

serviceTypestring

Filter by type: crew (personnel), fleet (vehicles) or general.

Available options: crew, fleet, general

collectionIdstring

Filter by identifier of the collection the service belongs to.

Limits: min length 1, max length 100

collectionIdsstring[]

Filter by collectionId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Limits: min 1 items, max 50 items, each min length 1, each max length 100

tagIdstring

Filter by tag identifier: services that carry that tag.

Limits: min length 1, max length 100

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data
idstring

Unique service identifier.

namestring

Service name as the customer sees it.

serviceTypestring

Type: crew (personnel), fleet (vehicles) or general.

descriptionstring | null

Description; null if it has none.

defaultQtyinteger

Quantity added to an order by default.

showInPlannerboolean

Whether it appears as a plannable service.

includeInPriceboolean

Whether its amount counts towards the document total.

collectionNamestring | null

Path of the collection it belongs to; null if it is in none.

tagsobject[]

Service tags, with their identifier and name.

Show child attributes
tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

requirementsobject[]

Resources needed to provide it.

Show child attributes
requirements.requiredResourceTypestring

What is needed to provide it: personnel or vehicle.

Available options: personnel, vehicle

requirements.qtyinteger

How many are needed.

Limits: min 1

requirements.requiredTagsstring[]

Tags the assigned resource must have. E.g.: "Carné C".

Limits: max 20 items, each max length 100

createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/services.

  • Services

    List services

    Returns the sellable services of the catalogue, cursor-paginated: personnel, transport and work days that do not come from inventory, with their requirements and tags.

  • Guides

    Safe writes

    An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.

  • Guides

    Errors

    A tool error is a result with isError: true and the problem in the first text block. Branch on its code.