Servicios

Listar servicios

Devuelve los servicios vendibles del catálogo, paginados por cursor: personal, transporte y jornadas de trabajo que no proceden del inventario, con sus requisitos y etiquetas.

GET
/api/v1/services

Ejemplos de petición

curl https://app.filmo.io/api/v1/services \
  --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"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}

Generado a partir del esquema

Filtra por tipo, colección y una única etiqueta. Ordenados por nombre; sort acepta un único campo. Los costes y el nombre interno no se publican; los filtros por fecha de creación y de actualización no están disponibles en este listado.

Autorizaciones

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

Parámetros de consulta

limitintegerpredeterminado:50

Tamaño de página (1-500). Por defecto es 50.

Límites: mín. 1, máx. 500

cursorstring

Cursor opaco de la página que se devuelve. Pasa el valor de pagination.nextCursor de la respuesta anterior; trátalo como opaco.

Límites: longitud máx. 200

sortstring

Orden: un único campo, con un "-" inicial para descendente (p. ej. "-updatedAt"). Campos ordenables: name, serviceType, defaultQty, createdAt, updatedAt. Por defecto, "name". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.

Límites: longitud máx. 200

serviceTypestring

Filtra por tipo: crew (personal), fleet (vehículos) o general.

Opciones disponibles: crew, fleet, general

collectionIdstring

Filtra por identificador de la colección a la que pertenece el servicio.

Límites: longitud mín. 1, longitud máx. 100

collectionIdsstring[]

Filtra por collectionId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

tagIdstring

Filtra por identificador de etiqueta: servicios que llevan esa etiqueta.

Límites: longitud mín. 1, longitud máx. 100

includeTotalbooleanpredeterminado:false

Ponlo en true para incluir pagination.total, el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: ServiceDto

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

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

dataobject[]

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.

paginationobject

Metadatos de paginación por cursor opaco.

Mostrar atributos hijos
pagination.nextCursorstring | null

Cursor opaco de la página siguiente; null cuando no hay más resultados. Pásalo como cursor en la siguiente petición.

pagination.hasMoreboolean

Si existen más resultados después de esta página.

pagination.totalinteger

Número de resultados que coinciden con los filtros en todas las páginas. Solo aparece cuando la petición establece includeTotal=true.

Límites: mín. 0

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
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.

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?