Intervals API Resource: module

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

The module resource is used to retrieve default modules. Default modules are always available to all projects. To create a module only available to one project, use the projectmodule 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 modules starting from the nth module.
limit	no	integer	10	Sets a limit to the amount of modules 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 /module/

To filter the list based on certain parameters:

GET /module/?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)
description	no	string (155)
active	yes	boolean

string (xxx) indicates a string with a maximum length of xxx characters.

Examples

To retrieve one member resource:

GET /module/{id}/

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