Servicios

Obtener un servicio

Devuelve un servicio vendible por su identificador: tipo, cantidad por defecto, si está incluido en el precio del documento y qué recursos se necesitan para prestarlo.

GET
/api/v1/services/{serviceId}

Ejemplos de petición

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"
  }
}

Generado a partir del esquema

NO emite su coste ni el nombre interno.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. services:read

Cabeceras

If-None-Matchstring

Lectura condicional: el ETag de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es 304 sin cuerpo.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

serviceIdstringObligatorio

Identificador del servicio.

Límites: longitud mín. 1

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: ServiceDto

Sobre: ServiceResponse. meta.warnings solo aparece cuando la operación está obsoleta.

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

dataobject

Línea vendible que no procede del inventario: personal, transporte, jornadas de trabajo.

Mostrar atributos hijos
data.idstring

Identificador único del servicio.

data.namestring

Nombre del servicio tal como lo ve el cliente.

data.serviceTypestring

Tipo: crew (personal), fleet (vehículos) o general.

data.descriptionstring | null

Descripción; null si no tiene.

data.defaultQtyinteger

Cantidad que se añade por defecto a un pedido.

data.showInPlannerboolean

Si aparece como servicio planificable.

data.includeInPriceboolean

Si su importe cuenta para el total del documento.

data.collectionNamestring | null

Ruta de la colección a la que pertenece; null si no está en ninguna.

data.tagsobject[]

Etiquetas del servicio, con su identificador y nombre.

Mostrar atributos hijos
data.tags.idstring

Identificador único de la etiqueta.

data.tags.namestring

Nombre de la etiqueta.

data.requirementsobject[]

Recursos necesarios para prestarlo.

Mostrar atributos hijos
data.requirements.requiredResourceTypestring

Lo necesario para prestarlo: personal o vehículo.

Opciones disponibles: personnel, vehicle

data.requirements.qtyinteger

Cuántos hacen falta.

Límites: mín. 1

data.requirements.requiredTagsstring[]

Etiquetas que debe tener el recurso asignado. Ej.: "Carné C".

Límites: máx. 20 elementos, cada uno: longitud máx. 100

data.createdAtstring<date-time> | null

Fecha de creación en ISO 8601 UTC; null si no consta.

data.updatedAtstring<date-time> | null

Fecha de la última modificación en ISO 8601 UTC; null si no está registrada.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
404not_foundNo existe o queda fuera del alcance de la clave de API.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones

  • Operaciones

    Servicio

    Línea vendible que no procede del inventario: personal, transporte, jornadas de trabajo.

¿Te ha resultado útil esta página?