Services

Get a service

Returns a sellable service by its identifier: type, default quantity, whether it is included in the document price and which resources are needed to provide it.

Tool
filmo_services_get
Access: Read

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_services_get",
    "arguments": {
      "serviceId": "serv_8f2a1c"
    }
  }
}

generated from the schema

It does NOT emit its cost or the internal name.

Arguments

serviceIdstringRequired

Service identifier.

Limits: min length 1

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/{serviceId}.

  • Services

    Get a service

    Returns a sellable service by its identifier: type, default quantity, whether it is included in the document price and which resources are needed to provide it.

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