Intervals API Resource:

worktype

The base URL for this resource is located at
https://api.myintervals.com/worktype/

The work type resource is used to retrieve default work types. Default work types are available to all projects. To create a work type only available to one project, use the projectworktype resource instead.

Collection

Allowed HTTP Methods
Method	Group Access
GET	Administrator

Allowed Filters
Filter Name	Required?	Expects	Default	Description
active	no	boolean
offset	no	integer		Return worktypes starting from the nth worktype.
limit	no	integer	10	Sets a limit to the amount of worktypes returned in the response.

¹ Indicates that multiple values are allowed, in CSV format (e.g. "3,5,11,19").
² This field accepts HTML, but certain HTML elements may be stripped out.

Examples

To retrieve the entire list of this resource:

GET /worktype/

To filter the list based on certain parameters:

GET /worktype/?active={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
Method	Group Access
GET	Administrator

Settable Fields for PUT and POST Requests
Field Name	Required?	Expects	Default	Description
name	yes	string (155)
defaulthourlyrate	yes	double
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 work type
name	no	Work type name
defaulthourlyrate	no	Default hourly rate when logging time with this work type (account currency) (May appear as a string in JSON (e.g. `"80"`).)
active	no	Whether the work type is active ("t") or inactive ("f")

Sample response object. Non-null values are strings in JSON (including IDs, numeric fields, and booleans as "t" / "f"). Nullable fields may be JSON null when absent.

{
    "id": "123456",
    "name": "Example Name",
    "defaulthourlyrate": "1.5",
    "active": "t"
}

When retrieving a collection (GET /worktype/), the response envelope includes: personid (authenticated user's ID), status ("OK"), code (200), listcount (total matching records before limit/offset), and worktype (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 /worktype/{id}/

Assuming no errors, the server will respond with 200 OK and the object requested.

Documentation

Resources

API Support

Looking for help?
Contact our support team.

OpenAPI

OpenAPI JSON spec (public)

Swagger UI on SwaggerHub

Start tracking time today

Connect Intervals to the tools and workflows your team already uses.

Try Intervals free