Solarware API-Dokumentation
YAML herunterladen

Aufgaben auflisten

Pagrierte Aufgaben. Optionale Filter `deals_id` und `status` (`to-do` / `done`). `search` durchsucht Titel und Beschreibung.

get /api/v1/tasks

Sicherheit

ApiKeyAuth

Parameter

Name In Typ Details
page query integer Optional
Default: 1
per_page query integer Optional Einträge pro Seite (1–100, Standard 15)
Default: 15
search query string Optional Suche über Entity-Felder und verschachtelte CRM-E-Mails/Telefone/Adressen
deals_id query integer Optional Filter by deal id
status query string Optional Optionaler Statusfilter

Antworten

200 Pagrierte Aufgaben

application/json

{
    "allOf": [
        {
            "title": "API envelope",
            "type": "object",
            "properties": {
                "success": {
                    "type": "boolean"
                },
                "message": {
                    "type": "string",
                    "nullable": true
                },
                "errors": {
                    "nullable": true
                },
                "meta": {
                    "type": "object",
                    "nullable": true,
                    "additionalProperties": true
                }
            }
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "type": "array",
                    "items": {
                        "title": "Task",
                        "type": "object",
                        "required": [
                            "id",
                            "title"
                        ],
                        "properties": {
                            "id": {
                                "type": "integer"
                            },
                            "title": {
                                "type": "string"
                            },
                            "description": {
                                "type": "string",
                                "nullable": true
                            },
                            "deals_id": {
                                "type": "integer",
                                "nullable": true
                            },
                            "type": {
                                "type": "string",
                                "nullable": true,
                                "enum": [
                                    "other",
                                    "call",
                                    "email"
                                ]
                            },
                            "status": {
                                "type": "string",
                                "nullable": true,
                                "enum": [
                                    "to-do",
                                    "done"
                                ]
                            },
                            "priority": {
                                "type": "string",
                                "nullable": true,
                                "enum": [
                                    "high",
                                    "low",
                                    "medium"
                                ]
                            },
                            "due_date": {
                                "type": "string",
                                "nullable": true
                            },
                            "start_time": {
                                "type": "string",
                                "nullable": true
                            },
                            "created_by": {
                                "type": "integer",
                                "nullable": true
                            },
                            "created_at": {
                                "type": "string",
                                "format": "date-time",
                                "nullable": true
                            },
                            "updated_at": {
                                "type": "string",
                                "format": "date-time",
                                "nullable": true
                            }
                        }
                    }
                },
                "meta": {
                    "type": "object",
                    "properties": {
                        "pagination": {
                            "title": "Pagination",
                            "type": "object",
                            "properties": {
                                "current_page": {
                                    "type": "integer"
                                },
                                "per_page": {
                                    "type": "integer"
                                },
                                "total": {
                                    "type": "integer"
                                },
                                "last_page": {
                                    "type": "integer"
                                },
                                "from": {
                                    "type": "integer",
                                    "nullable": true
                                },
                                "to": {
                                    "type": "integer",
                                    "nullable": true
                                }
                            }
                        }
                    }
                }
            }
        }
    ]
}
401 Missing or invalid API key

application/json

{
    "type": "object",
    "properties": {
        "success": {
            "type": "boolean",
            "example": false
        },
        "message": {
            "type": "string",
            "example": "Missing API key (X-Api-Key)"
        }
    }
}