Filter tasks

GET

/api/partners/v1/community/{community_id}/tasks/

Filter tasks for a community

Authorizations

• BasicAuth
• BearerAuth

Parameters

Path Parameters

community_id

required

string

The Community ID, this will look like either ‘1234’ or ‘P1234-567’. Alternatively, if you prefix this value with partner-id:, for example partner-id:apts123 you can use your own community, as long as you have previously provided that ID to Funnel.

Examples

Funnel Community ID

The raw integer Funnel ID of a community.

1234

Funnel Community Syndication ID

The community’s Funnel syndcation ID. An ID in this format is often provided in Funnel feeds to ILS partners.

P1234-567

Partner ID

The ID of the community in the partner system. This needs to have been previously provided to Funnel and setup.

partner-id:apts123

Query Parameters

task_id

string

The primary key of the task.

Example

123

funnel_renter_id

string

The client’s funnel id (often referred to as client id or prospect id), this will look like ‘1234’.

Example

123

funnel_team_id

string

The employee group id associated with the reminder, this will look like ‘1234’.

Example

123

due_date_before

string format: date

The tasks with a due date before this date.

Example

2023-01-01

due_date_after

string format: date

The tasks with a due date after this date.

Example

2023-01-01

status

string

The status of the reminder.

Example

Active

created_at_before

string format: date

To filter reminders with a created_at date before this date.

Example

2023-01-01

created_at_after

string format: date

To filter reminders with a created_at date after this date.

Example

2023-01-01

assignee_funnel_user_id

string

The User ID the reminder is assigned to..

Example

123

task_category

string

The task category.

Example

12345

Responses

200

Task list matching the filter parameters passed.

object

items

Array<object>

object

task_id

Task primary key

string

123

due_date

Task due date

string format: date

2023-10-05

status

Status of the task.

string

Allowed values: Active Canceled Completed Not Applicable

task_type

Task Type

string

Allowed values: CUSTOM FOLLOW_UP BIRTHDAY SEND_EMAIL SEND_SMS MAKE_A_CALL

funnel_renter_id

Team ID to assign task to

integer

nullable

funnel_team_id

Group ID of the reminder

integer

nullable

assignee_funnel_user_id

Agent IT to assign task to

integer

nullable

description

Task Description

string

Call about renewal options

created_at

Datetime of task creation

string format: date-time

2023-10-04T00:02:23

task_category

Task Category ID

integer

page

integer

total_pages

integer

total_items

integer

400

401

403

We were unable to authenticate your request with the provided API key.

object

error_type

string

CommunityNotFound

message

string

Could not find community with corresponding ID.

404

A community with this ID does not exist.

object

error_type

string

CommunityNotFound

message

string

Could not find community with corresponding ID.