*REST API › Objects › Operations*

# Service

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

A sellable line that does not come from inventory: personnel, transport or work days. A service says whether it shows in the planner and whether it is included in the price, and it can carry requirements. The cost of the service and its internal name are not published.

Schemas: `ServiceDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Unique service identifier. |
| `name` | string | Service name as the customer sees it. |
| `serviceType` | string | Type: crew (personnel), fleet (vehicles) or general. |
| `description` | string | Description; null if it has none. |
| `defaultQty` | integer | Quantity added to an order by default. |
| `showInPlanner` | boolean | Whether it appears as a plannable service. |
| `includeInPrice` | boolean | Whether its amount counts towards the document total. |
| `collectionName` | string | Path of the collection it belongs to; null if it is in none. |
| `tags` | object[] | Service tags, with their identifier and name. |
| `tags.id` | string | Unique identifier of the tag. |
| `tags.name` | string | Tag name. |
| `requirements` | object[] | Resources needed to provide it. |
| `requirements.requiredResourceType` | string | What is needed to provide it: personnel or vehicle. `personnel`, `vehicle` |
| `requirements.qty` | integer | How many are needed. |
| `requirements.requiredTags` | string[] | Tags the assigned resource must have. E.g.: "Carné C". |
| `createdAt` | string<date-time> | Creation date in ISO 8601 UTC; null if not recorded. |
| `updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC; null if not recorded. |

## Example

*Service · Generated from the schema*

```json
{
  "id": "id_8f2a1c",
  "name": "Example",
  "serviceType": "string",
  "description": "string",
  "defaultQty": 1,
  "showInPlanner": true,
  "includeInPrice": true,
  "collectionName": "Example",
  "tags": [
    {
      "id": "id_8f2a1c",
      "name": "Example"
    }
  ],
  "requirements": [
    {
      "requiredResourceType": "personnel",
      "qty": 1,
      "requiredTags": [
        "string"
      ]
    }
  ],
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}
```

## Returned by

- [`GET /api/v1/services`](https://docs.filmo.io/rest-api/endpoint-reference/services/list-services) — List services
- [`GET /api/v1/services/{serviceId}`](https://docs.filmo.io/rest-api/endpoint-reference/services/get-a-service) — Get a service

## Modified by

- [`POST /api/v1/services`](https://docs.filmo.io/rest-api/endpoint-reference/services/create-a-service) — Create a service
- [`PATCH /api/v1/services/{serviceId}`](https://docs.filmo.io/rest-api/endpoint-reference/services/update-a-service) — Update a service

---

Canonical URL: https://docs.filmo.io/rest-api/objects/service  
Last updated: 2026-10-25