Raw schema
{
"type": "object",
"properties": {
"workspace_id": {
"description": "Workspace id (from clockify_list_workspaces). Default: your active workspace.",
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
},
"from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "First day of the report, yyyy-mm-dd (inclusive). On Clockify's FREE plan a report spans at most 31 days."
},
"to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Last day of the report, yyyy-mm-dd (inclusive)."
},
"user_ids": {
"description": "Only these users (ids).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
},
"project_ids": {
"description": "Only these projects (ids).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
},
"client_ids": {
"description": "Only these clients (ids).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
},
"tag_ids": {
"description": "Only these tags (ids).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$"
}
},
"billable": {
"description": "true = only billable time, false = only non-billable. Default: both.",
"type": "boolean"
},
"description": {
"description": "Only entries whose description contains this text.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"time_zone": {
"description": "IANA time zone the dates are read in, e.g. Europe/Berlin. Default: your Clockify profile's time zone.",
"type": "string",
"maxLength": 64,
"pattern": "^[A-Za-z]+(?:[/_+-][A-Za-z0-9_+-]+){0,3}$"
},
"group_by": {
"description": "Grouping levels, outermost first (default [PROJECT, TIMEENTRY]).",
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"PROJECT",
"CLIENT",
"TASK",
"TAG",
"USER",
"USER_GROUP",
"DATE",
"WEEK",
"MONTH",
"TIMEENTRY"
]
}
}
},
"required": [
"from",
"to"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}