Intervals API Resource:
tasklistfilter
The base URL for this resource is located at
https://api.myintervals.com/tasklistfilter/
Collection
| Allowed HTTP Methods | |
|---|---|
| Method | Group Access |
| GET | Administrator, Manager, Resource, Executive |
| Allowed Filters | ||||
|---|---|---|---|---|
| Filter Name | Required? | Expects | Default | Description |
| offset | no | integer | 0 | Return tasklistfilters starting from the nth tasklistfilter. |
| limit | no | integer | 10 | Sets a limit to the amount of tasklistfilters returned in the response. |
1 Indicates that multiple values are allowed, in CSV format (e.g. "3,5,11,19").
2 This field accepts HTML, but certain HTML elements may be stripped out.
Examples
To retrieve the entire list of this resource:
GET /tasklistfilter/
To filter the list based on certain parameters:
GET /tasklistfilter/?limit={value}
Note: You can string together multiple filters.
Member
| Allowed HTTP Methods | |
|---|---|
| Method | Group Access |
| GET | Administrator, Manager, Resource, Executive |
| Settable Fields for PUT and POST Requests | ||||
|---|---|---|---|---|
| Field Name | Required? | Expects | Default | Description |
| personid | yes | integer | ||
| title | yes | string (255) | ||
| params | yes | string | ||
| date | yes | |||
string (xxx) indicates a string with a maximum length of xxx characters.
Response Fields
The fields below are returned in GET responses. Boolean values are "t" / "f" strings. Numeric IDs and floats are returned as strings. Nullable fields may be JSON null.
| Response Fields | ||
|---|---|---|
| Field Name | Nullable | Description |
| id | no | Unique identifier for the filter |
| filtertypeid | no | ID of the filter type (e.g. tasks vs other list kinds) |
| personid | no | ID of the person who owns this filter |
| title | no | User-visible name for the saved filter |
| subfilterid | yes | Optional nested filter id (empty when not used) |
| shared | no | Whether the filter is shared with others ("t"/"f") |
| scheduled | no | Whether this filter is used on a schedule ("t"/"f") |
| filtertype | no | Filter type key or label (e.g. tasks) |
| person | no | Full name of the owning person |
| datesent | yes | When a scheduled report was last sent (empty when not scheduled or never sent) |
When retrieving a collection (GET /tasklistfilter/), the response envelope includes: personid (authenticated user's ID), status ("OK"), code (200), listcount (total matching records before limit/offset), and tasklistfilter (array of result objects). Defaults, no cap on limit, and how to paginate using listcount are described in the API Introduction (Pagination).
Examples
To retrieve one member resource:
GET /tasklistfilter/{id}/
Assuming no errors, the server will respond with 200 OK and the object requested.
Documentation
Resources
- client
- contactdescriptor
- contacttype
- document
- expense
- group
- invoice
- invoiceitem
- invoicenote
- invoiceterm
- me
- milestone
- milestonenote
- module
- payment
- paymenttype
- person
- personcontact
- project
- projectlabel
- projectmodule
- projectnote
- projectteam
- projectworktype
- quota
- request
- task
- tasklistfilter
- tasknote
- taskpriority
- taskstatus
- time
- timer
- worktype
API Support
Looking for help?
Contact our support team.
OpenAPI
OpenAPI JSON spec (public)
Start tracking time today
Connect Intervals to the tools and workflows your team already uses.
Try Intervals free