Intervals API Resource: module

The base URL for this resource is located at

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.


Allowed HTTP Methods
MethodGroup Access
Allowed Filters
Filter NameRequired?ExpectsDefaultDescription
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.

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.


To retrieve the entire list of this resource:

GET /module/

To filter the list based on certain parameters:

GET /module/?limit={value}

Note: You can string together multiple filters.


Allowed HTTP Methods
MethodGroup Access
Settable Fields for PUT and POST Requests
Field NameRequired?ExpectsDefaultDescription
name yes string (155)
description no string (155)
active yes boolean

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


To retrieve one member resource:

GET /module/{id}/

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

Don’t have an Intervals account? Start your own unlimited trial.

No credit card required. No software to install. Cancel any time.

Try it Free