Intervals API Resource:
taskstatus
The base URL for this resource is located at
https://api.myintervals.com/taskstatus/
Collection
| Allowed HTTP Methods | |
|---|---|
| Method | Group Access |
| GET | Administrator, Manager, Resource, Executive |
| Allowed Filters | ||||
|---|---|---|---|---|
| Filter Name | Required? | Expects | Default | Description |
| active | no | boolean | ||
| offset | no | integer | Return taskstatuses starting from the nth taskstatus. | |
| limit | no | integer | 10 | Sets a limit to the amount of taskstatuses 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 /taskstatus/
To filter the list based on certain parameters:
GET /taskstatus/?active={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 |
| name | yes | string (55) | ||
| active | yes | boolean | ||
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 task status |
| name | no | Status name (e.g. Open, In Progress) |
| priority | no | Workflow order for this status within the account (lower values come first in the pipeline; string in JSON, e.g. `"1"` … `"10"`) |
| frozen | no | Whether this status is frozen and cannot be edited or reordered in the UI ("t"/"f") |
| active | no | Whether the status is in use ("t") or retired ("f") |
When retrieving a collection (GET /taskstatus/), the response envelope includes: personid (authenticated user's ID), status ("OK"), code (200), listcount (total matching records before limit/offset), and taskstatus (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 /taskstatus/{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