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.

GET
/api/v1/services/{serviceId}

Request examples

curl https://app.filmo.io/api/v1/services/serv_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": {
    "id": "service_9f3a2b",
    "name": "Example service",
    "serviceType": "Example service type",
    "description": "Example text.",
    "defaultQty": 1,
    "showInPlanner": true,
    "includeInPrice": true,
    "collectionName": "Example collection name",
    "tags": [
      {
        "id": "tag_9f3a2b",
        "name": "Example tag"
      }
    ],
    "requirements": [
      {
        "requiredResourceType": "personnel",
        "qty": 1,
        "requiredTags": [
          "Example required tags"
        ]
      }
    ],
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

Generated from the schema

It does NOT emit its cost or the internal name.

Authorizations

Bearer API key with the scope below. services:read

Headers

If-None-Matchstring

Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

serviceIdstringRequired

Service identifier.

Limits: min length 1

Response

application/json

Successful response.

Response schema: ServiceDto

Envelope: ServiceResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

Sellable line that does not come from inventory: personnel, transport, work days.

Show child attributes
data.idstring

Unique service identifier.

data.namestring

Service name as the customer sees it.

data.serviceTypestring

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

data.descriptionstring | null

Description; null if it has none.

data.defaultQtyinteger

Quantity added to an order by default.

data.showInPlannerboolean

Whether it appears as a plannable service.

data.includeInPriceboolean

Whether its amount counts towards the document total.

data.collectionNamestring | null

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

data.tagsobject[]

Service tags, with their identifier and name.

Show child attributes
data.tags.idstring

Unique identifier of the tag.

data.tags.namestring

Tag name.

data.requirementsobject[]

Resources needed to provide it.

Show child attributes
data.requirements.requiredResourceTypestring

What is needed to provide it: personnel or vehicle.

Available options: personnel, vehicle

data.requirements.qtyinteger

How many are needed.

Limits: min 1

data.requirements.requiredTagsstring[]

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

Limits: max 20 items, each max length 100

data.createdAtstring<date-time> | null

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

data.updatedAtstring<date-time> | null

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

metaobject

Additional information about the response.

Show child attributes
meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes
meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

Errors

StatusCodesMeaning
404not_foundIt does not exist or is outside the scope of the API key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

  • Operations

    Service

    Sellable line that does not come from inventory: personnel, transport, work days.