📝 Checklists — Solved API

Endpoint

GET /checklists
https://europe-west1-try-solved.cloudfunctions.net/api/checklists

Authentication

The API uses Firebase Authentication Bearer tokens.

Authorization: Bearer <token>
Content-Type: application/json

The token is obtained by signing in with Firebase using your Solved account credentials.

Query Parameters

Parameter

Type

Required

Description

Valid status values

uncomplete, planned, closedOk, closedKo, closedWithWarning,
closedUncomplete, correctionApplied, pendingForVerification

Smart Date Filtering Logic

The API automatically applies the date filter to the most relevant field depending on checklist status:

• planned → plannedDate

• uncomplete → creationDate

• closed / verified statuses → executionDate

• no status filter → matches if any date field falls within the range

This prevents common reporting mistakes when mixing statuses and dates.

Example Request

GET /checklists?startDate=2026-01-01T00:00:00Z&endDate=2026-02-01T00:00:00Z&status=closedOk&pageSize=10

Responses

200 OK — Results Found

Returns full checklists with sections and controls.

{
  "checklists": [...],
  "total": 142,
  "page": 0,
  "pageSize": 10,
  "hasMore": true
}

200 OK — No Results

{
  "checklists": [],
  "total": 0,
  "hasMore": false
}

Common Errors

• 400 — Missing or invalid parameters

• 401 — Missing or invalid authentication token

Data Model

Checklist

Represents a complete checklist including metadata, dates, users, and sections.

Key fields:

• refId

• status

• creationDate, executionDate, plannedDate

• owner, verifier, executors

• sections

Note: planned checklists are virtual (not yet executed). They expose the template structure without filled values.

Section

Each checklist contains one or more sections, each with its own status and controls.

Control

Represents a single user-filled field within a section.

• Supported types: Text, Select, Date, User, Media, etc.

• Supports corrections, comments, and attached media

Pagination

The API includes pagination metadata to efficiently handle large datasets:

• total

• page

• pageSize

• hasMore

Example:

GET /checklists?...&page=1&pageSize=50

Usage Examples

Firebase Authentication (Python)

def get_firebase_token(email, password):
    ...

Basic Query (Python)

response = requests.get(
  f"{BASE_URL}/checklists",
  headers=headers,
  params={...}
)

Full Pagination Download

Recommended for exports and data synchronization.

while hasMore:
   ...

JavaScript (Fetch)

const response = await fetch(`${BASE_URL}/checklists?...`);

Export to CSV (JavaScript)

Creates one row per control, ideal for Excel or BI tools.

const rows = [["RefId", "Checklist", "Status", ...]];

Common Use Cases

• External reporting & dashboards

• Audit-ready data exports

• ERP / BI integrations

• Automations & historical analysis