API Reference

List and Filter Tasks

get
https://crm-api.portals.care/tasks

Retrieves a list of tasks, which can be filtered by various criteria such as status, owner, type, or associated patient (relatedToLead). By default, it returns open tasks; set showClosed=true to include completed tasks.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

If true, the response will include tasks that are closed or completed. Defaults to false.

string

Filter tasks by a specific type (e.g., consultation, follow-up).

string

Filter tasks by the _id of the assigned owner (CRM user).

string
enum

Filter tasks by their current status (e.g., pending, completed).

Allowed:
string

Filter tasks by a keyword in their description.

string

Filter tasks associated with a specific lead _id.

string

Filter tasks by one or more tags.

Headers
string
required

Your unique Organization ID.

Response

Updated 9 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

Did this page help you?