API docs by Redocly

Redmine API (1.7.0+redmine6.1)

Download OpenAPI specification:

URL: https://github.com/d-yoshi/redmine-openapi License: MIT

Unofficial OpenAPI specification for the Redmine API, tested against Redmine 6.1

Redmine API Official Developer Guide

Issues

Status: Stable, Availability: 1.0

https://www.redmine.org/projects/redmine/wiki/Rest_Issues

List issues

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Listing-issues
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
query Parameters
offset
integer
limit
integer
nometa
integer
Value: 1
sort
string
Example: sort=id:desc

Sort order. Comma-separated list of field or field:desc. Default direction is ascending. Examples: id:desc, status:desc,id

include
Array of strings
Items Enum: "attachments" "relations"

Comma-separated list of associated data to include for each issue. Values: attachments (file attachments), relations (issue relations)

issue_id
string

Filter by issue ID. Format: [operator]value Operators: = (default), >=, <=, >< (between, pipe-separated), * (any), !* (none) Examples: 1, >=100, ><1|100

project_id
string

Filter by project. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Special values: mine (projects where current user is a member), bookmarks (bookmarked projects) Examples: 1|2, mine, !mine

subproject_id
string

Filter by subproject. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1|2, *, !*

tracker_id
string

Filter by tracker. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), ev (has ever been), !ev (has never been), cf (changed from) Examples: 1|2, !3

status_id
string

Filter by issue status. Format: [operator]value[|value2|...] Operators: o (open), = (default), ! (not equal), c (closed), * (any), ev (has ever been), !ev (has never been), cf (changed from) Examples: o, 1|2, c, !3

priority_id
string

Filter by priority. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), ev (has ever been), !ev (has never been), cf (changed from) Examples: 1|2, !3

assigned_to_id
string

Filter by assignee. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none), ev (has ever been), !ev (has never been), cf (changed from) Special values: me (current user) Examples: 1, me, !*, !me

author_id
string

Filter by author. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Special values: me (current user) Examples: 1, me, !me

author.group
string

Filter by author's group. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2

author.role
string

Filter by author's role. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2

member_of_group
string

Filter by assignee's group membership. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1, *

assigned_to_role
string

Filter by assignee's role. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1, *

fixed_version_id
string

Filter by target version. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none), ev (has ever been), !ev (has never been), cf (changed from) Examples: 1|2, !*

fixed_version.due_date
string

Filter by target version's due date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), nd (tomorrow), w (this week), lw (last week), l2w (last 2 weeks), nw (next week), m (this month), lm (last month), nm (next month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), t+ (in n days), >t+ (in more than n days), <t+ (in less than n days), ><t+ (between n1 and n2 days from now), * (any), !* (none) Examples: >=2024-01-01, t, >t-7

fixed_version.status
string

Filter by target version's status. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Values: open, locked, closed Examples: open, open|locked, !closed

category_id
string

Filter by category. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none), ev (has ever been), !ev (has never been), cf (changed from) Examples: 1|2, !*

parent_id
string

Filter by parent issue. Format: [operator]value Operators: = (exact parent ID), ~ (descendant of, subtree search), * (any, i.e. is a subtask), !* (none, i.e. is a root issue) Examples: 123, ~123, *, !*

child_id
string

Filter by child issue. Format: [operator]value Operators: = (exact child ID), ~ (ancestor of, subtree search), * (any, i.e. has subtasks), !* (none, i.e. is a leaf issue) Examples: 123, ~123, *, !*

object
Example: cf_0=string

Filter by custom field value. Replace x with the custom field ID (e.g., cf_1, cf_12). Format and operators depend on the custom field type (string, int, date, list, etc.) and follow the same conventions as other filter parameters. Examples: cf_1=~keyword, cf_5=1|2, cf_10=>=2024-01-01

subject
string

Filter by subject. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword, ^prefix

description
string

Filter by description. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword, !~excluded

notes
string

Filter by journal notes. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword

created_on
string

Filter by creation date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), * (any), !* (none) Examples: >=2024-01-01, t, >t-7, lm

updated_on
string

Filter by last updated date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), * (any), !* (none) Examples: >=2024-01-01, t, >t-7, lm

closed_on
string

Filter by closed date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), * (any), !* (none) Examples: >=2024-01-01, t, >t-7, lm

start_date
string

Filter by start date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), nd (tomorrow), w (this week), lw (last week), l2w (last 2 weeks), nw (next week), m (this month), lm (last month), nm (next month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), t+ (in n days), >t+ (in more than n days), <t+ (in less than n days), ><t+ (between n1 and n2 days from now), * (any), !* (none) Examples: >=2024-01-01, t, >t-7

due_date
string

Filter by due date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), nd (tomorrow), w (this week), lw (last week), l2w (last 2 weeks), nw (next week), m (this month), lm (last month), nm (next month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), t+ (in n days), >t+ (in more than n days), <t+ (in less than n days), ><t+ (between n1 and n2 days from now), * (any), !* (none) Examples: >=2024-01-01, t, >t-7

estimated_hours
string

Filter by estimated hours. Format: [operator]value Operators: = (default), >=, <=, >< (between, pipe-separated), * (any), !* (none) Examples: >=5, ><1|10, !*

spent_time
string

Filter by total spent time. Format: [operator]value Operators: = (default), >=, <=, >< (between, pipe-separated), * (any), !* (none) Examples: >=5, ><1|10, !*

done_ratio
string

Filter by done ratio (percentage). Format: [operator]value Operators: = (default), >=, <=, >< (between, pipe-separated), * (any), !* (none) Examples: >=50, ><0|99, 100

is_private
string

Filter by private flag. Format: [operator]value Operators: = (default), ! (not equal) Values: 1 (private), 0 (not private) Examples: 1, 0

attachment
string

Filter by attachment filename. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~report, *.pdf

attachment_description
string

Filter by attachment description. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~screenshot

watcher_id
string

Filter by watcher. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Special values: me (current user) Examples: 1, me, !me

updated_by
string

Filter by user who updated the issue. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Special values: me (current user) Examples: 1, me

last_updated_by
string

Filter by user who last updated the issue. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Special values: me (current user) Examples: 1, me

project.status
string

Filter by project status. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Values: 1 (active), 5 (closed) Examples: 1, !5

relates
string

Filter by "relates to" relation. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), =p (same project), =!p (different project), !p (not in project), *o (related to open issue), !o (related to closed issue), * (any), !* (none) Examples: 123, =p, *o, *

duplicates
string

Filter by "duplicates" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

duplicated
string

Filter by "duplicated by" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

blocks
string

Filter by "blocks" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *o

blocked
string

Filter by "blocked by" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *o

precedes
string

Filter by "precedes" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

follows
string

Filter by "follows" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

copied_to
string

Filter by "copied to" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

copied_from
string

Filter by "copied from" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

any_searchable
string

Full-text search across all searchable fields. Format: <operator>value Operators: ~ (contains all words), *~ (contains any word), !~ (not contains) Examples: ~keyword, *~foo bar

query_id
integer

ID of a saved query to apply. When specified, the saved query's filter criteria are used. Other filter parameters in the same request are ignored. Use GET /queries.json to retrieve available saved queries.

header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "issues": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Create issue

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Creating-an-issue
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "issue": {
    }
}

Response samples

Content type
application/json
{
  • "issue": {
    }
}

Show issue

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Showing-an-issue
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_id
required
integer
query Parameters
include
Array of strings
Items Enum: "children" "attachments" "relations" "changesets" "journals" "watchers" "allowed_statuses"

Comma-separated list of associated data to include in the response. Values: children (child issues), attachments (file attachments), relations (issue relations), changesets (associated VCS changesets), journals (change history and notes), watchers (users watching the issue), allowed_statuses (status transitions available for the current user)

header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "issue": {
    }
}

Update issue

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Updating-an-issue
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "issue": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete issue

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Deleting-an-issue
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

List issues by project

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Listing-issues
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
query Parameters
offset
integer
limit
integer
nometa
integer
Value: 1
sort
string
Example: sort=id:desc

Sort order. Comma-separated list of field or field:desc. Default direction is ascending. Examples: id:desc, status:desc,id

include
Array of strings
Items Enum: "attachments" "relations"

Comma-separated list of associated data to include for each issue. Values: attachments (file attachments), relations (issue relations)

issue_id
string

Filter by issue ID. Format: [operator]value Operators: = (default), >=, <=, >< (between, pipe-separated), * (any), !* (none) Examples: 1, >=100, ><1|100

subproject_id
string

Filter by subproject. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1|2, *, !*

tracker_id
string

Filter by tracker. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), ev (has ever been), !ev (has never been), cf (changed from) Examples: 1|2, !3

status_id
string

Filter by issue status. Format: [operator]value[|value2|...] Operators: o (open), = (default), ! (not equal), c (closed), * (any), ev (has ever been), !ev (has never been), cf (changed from) Examples: o, 1|2, c, !3

priority_id
string

Filter by priority. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), ev (has ever been), !ev (has never been), cf (changed from) Examples: 1|2, !3

assigned_to_id
string

Filter by assignee. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none), ev (has ever been), !ev (has never been), cf (changed from) Special values: me (current user) Examples: 1, me, !*, !me

author_id
string

Filter by author. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Special values: me (current user) Examples: 1, me, !me

author.group
string

Filter by author's group. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2

author.role
string

Filter by author's role. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2

member_of_group
string

Filter by assignee's group membership. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1, *

assigned_to_role
string

Filter by assignee's role. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1, *

fixed_version_id
string

Filter by target version. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none), ev (has ever been), !ev (has never been), cf (changed from) Examples: 1|2, !*

fixed_version.due_date
string

Filter by target version's due date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), nd (tomorrow), w (this week), lw (last week), l2w (last 2 weeks), nw (next week), m (this month), lm (last month), nm (next month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), t+ (in n days), >t+ (in more than n days), <t+ (in less than n days), ><t+ (between n1 and n2 days from now), * (any), !* (none) Examples: >=2024-01-01, t, >t-7

fixed_version.status
string

Filter by target version's status. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Values: open, locked, closed Examples: open, open|locked, !closed

category_id
string

Filter by category. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none), ev (has ever been), !ev (has never been), cf (changed from) Examples: 1|2, !*

parent_id
string

Filter by parent issue. Format: [operator]value Operators: = (exact parent ID), ~ (descendant of, subtree search), * (any, i.e. is a subtask), !* (none, i.e. is a root issue) Examples: 123, ~123, *, !*

child_id
string

Filter by child issue. Format: [operator]value Operators: = (exact child ID), ~ (ancestor of, subtree search), * (any, i.e. has subtasks), !* (none, i.e. is a leaf issue) Examples: 123, ~123, *, !*

object
Example: cf_0=string

Filter by custom field value. Replace x with the custom field ID (e.g., cf_1, cf_12). Format and operators depend on the custom field type (string, int, date, list, etc.) and follow the same conventions as other filter parameters. Examples: cf_1=~keyword, cf_5=1|2, cf_10=>=2024-01-01

subject
string

Filter by subject. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword, ^prefix

description
string

Filter by description. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword, !~excluded

notes
string

Filter by journal notes. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword

created_on
string

Filter by creation date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), * (any), !* (none) Examples: >=2024-01-01, t, >t-7, lm

updated_on
string

Filter by last updated date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), * (any), !* (none) Examples: >=2024-01-01, t, >t-7, lm

closed_on
string

Filter by closed date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), * (any), !* (none) Examples: >=2024-01-01, t, >t-7, lm

start_date
string

Filter by start date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), nd (tomorrow), w (this week), lw (last week), l2w (last 2 weeks), nw (next week), m (this month), lm (last month), nm (next month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), t+ (in n days), >t+ (in more than n days), <t+ (in less than n days), ><t+ (between n1 and n2 days from now), * (any), !* (none) Examples: >=2024-01-01, t, >t-7

due_date
string

Filter by due date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), nd (tomorrow), w (this week), lw (last week), l2w (last 2 weeks), nw (next week), m (this month), lm (last month), nm (next month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), t+ (in n days), >t+ (in more than n days), <t+ (in less than n days), ><t+ (between n1 and n2 days from now), * (any), !* (none) Examples: >=2024-01-01, t, >t-7

estimated_hours
string

Filter by estimated hours. Format: [operator]value Operators: = (default), >=, <=, >< (between, pipe-separated), * (any), !* (none) Examples: >=5, ><1|10, !*

spent_time
string

Filter by total spent time. Format: [operator]value Operators: = (default), >=, <=, >< (between, pipe-separated), * (any), !* (none) Examples: >=5, ><1|10, !*

done_ratio
string

Filter by done ratio (percentage). Format: [operator]value Operators: = (default), >=, <=, >< (between, pipe-separated), * (any), !* (none) Examples: >=50, ><0|99, 100

is_private
string

Filter by private flag. Format: [operator]value Operators: = (default), ! (not equal) Values: 1 (private), 0 (not private) Examples: 1, 0

attachment
string

Filter by attachment filename. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~report, *.pdf

attachment_description
string

Filter by attachment description. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~screenshot

watcher_id
string

Filter by watcher. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Special values: me (current user) Examples: 1, me, !me

updated_by
string

Filter by user who updated the issue. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Special values: me (current user) Examples: 1, me

last_updated_by
string

Filter by user who last updated the issue. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Special values: me (current user) Examples: 1, me

project.status
string

Filter by project status. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Values: 1 (active), 5 (closed) Examples: 1, !5

relates
string

Filter by "relates to" relation. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), =p (same project), =!p (different project), !p (not in project), *o (related to open issue), !o (related to closed issue), * (any), !* (none) Examples: 123, =p, *o, *

duplicates
string

Filter by "duplicates" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

duplicated
string

Filter by "duplicated by" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

blocks
string

Filter by "blocks" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *o

blocked
string

Filter by "blocked by" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *o

precedes
string

Filter by "precedes" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

follows
string

Filter by "follows" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

copied_to
string

Filter by "copied to" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

copied_from
string

Filter by "copied from" relation. Format: [operator]value[|value2|...] Operators: =, !, =p, =!p, !p, *o, !o, *, !* Examples: 123, *

any_searchable
string

Full-text search across all searchable fields. Format: <operator>value Operators: ~ (contains all words), *~ (contains any word), !~ (not contains) Examples: ~keyword, *~foo bar

query_id
integer

ID of a saved query to apply. When specified, the saved query's filter criteria are used. Other filter parameters in the same request are ignored. Use GET /queries.json to retrieve available saved queries.

header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "issues": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Create issue under project

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Creating-an-issue
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "issue": {
    }
}

Response samples

Content type
application/json
{
  • "issue": {
    }
}

Add watcher

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Adding-a-watcher
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
user_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "user_id": 0
}

Remove watcher

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Removing-a-watcher
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_id
required
integer
user_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Projects

Status: Stable, Availability: 1.0

https://www.redmine.org/projects/redmine/wiki/Rest_Projects

List projects

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Listing-projects
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
query Parameters
offset
integer
limit
integer
nometa
integer
Value: 1
include
Array of strings
Items Enum: "trackers" "issue_categories" "time_entry_activities" "enabled_modules" "issue_custom_fields"

Comma-separated list of associated data to include for each project. Values: trackers (available issue trackers), issue_categories (issue categories), time_entry_activities (time entry activity types), enabled_modules (enabled modules/features), issue_custom_fields (custom fields for issues)

status
string

Filter by project status. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Values: 1 (active), 5 (closed) Examples: 1, 1|5, !1

id
string

Filter by project ID. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Special values: mine (projects where current user is a member), bookmarks (bookmarked projects) Examples: 1|2|3, mine, !mine, mine|bookmarks

name
string

Filter by project name. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword, ^prefix

description
string

Filter by project description. Format: <operator>value Operators: ~ (contains), !~ (not contains), *~ (contains any word), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword, !~excluded

parent_id
string

Filter by parent project. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any, i.e. is a subproject), !* (none, i.e. is a root project) Special values: mine (projects where current user is a member), bookmarks (bookmarked projects) Examples: 1|2, mine, *, !*

is_public
string

Filter by public/private status. Format: [operator]value Operators: = (default), ! (not equal) Values: 1 (public), 0 (private) Examples: 1, !1

created_on
string

Filter by creation date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), * (any), !* (none) Examples: >=2024-01-01, ><2024-01-01|2024-12-31, t, >t-7, lm

updated_on
string

Filter by last updated date. Format: <operator>[value] Operators: = (on date), >= (on or after), <= (on or before), >< (between, pipe-separated), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), t- (n days ago), >t- (less than n days ago), <t- (more than n days ago), ><t- (between n1 and n2 days ago), * (any), !* (none) Examples: >=2024-01-01, ><2024-01-01|2024-12-31, t, >t-7, lm

header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "projects": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Create project

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Creating-a-project
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "project": {
    }
}

Show project

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Showing-a-project
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
query Parameters
include
Array of strings
Items Enum: "trackers" "issue_categories" "time_entry_activities" "enabled_modules" "issue_custom_fields"

Comma-separated list of associated data to include in the response. Values: trackers (available issue trackers), issue_categories (issue categories), time_entry_activities (time entry activity types), enabled_modules (enabled modules/features), issue_custom_fields (custom fields for issues)

header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "project": {
    }
}

Update project

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Updating-a-project
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete project

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Deleting-a-project
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Archive project

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Archiving-a-project
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Unarchive project

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Unarchiving-a-project
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Close project

Undocumented: This operation is not listed in the official documentation.

Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Reopen project

Undocumented: This operation is not listed in the official documentation.

Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Project Memberships

Status: Alpha, Availability: 1.4

https://www.redmine.org/projects/redmine/wiki/Rest_Memberships

List memberships

https://www.redmine.org/projects/redmine/wiki/Rest_Memberships#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
query Parameters
offset
integer
limit
integer
nometa
integer
Value: 1
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "memberships": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Create membership

https://www.redmine.org/projects/redmine/wiki/Rest_Memberships#POST
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "membership": {
    }
}

Response samples

Content type
application/json
{
  • "membership": {
    }
}

Show membership

https://www.redmine.org/projects/redmine/wiki/Rest_Memberships#GET-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
membership_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "membership": {
    }
}

Update membership

https://www.redmine.org/projects/redmine/wiki/Rest_Memberships#PUT
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
membership_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "membership": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete membership

https://www.redmine.org/projects/redmine/wiki/Rest_Memberships#DELETE
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
membership_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Users

Status: Stable, Availability: 1.1

https://www.redmine.org/projects/redmine/wiki/Rest_Users

List users

https://www.redmine.org/projects/redmine/wiki/Rest_Users#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
query Parameters
offset
integer
limit
integer
nometa
integer
Value: 1
include
Array of strings
Items Value: "auth_source"

Comma-separated list of associated data to include for each user. Values: auth_source (authentication source information)

status
string

Filter by user status. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Values: 1 (active), 2 (registered), 3 (locked) Examples: 1, 1|2, !3

name
string

Filter by name, login, or email (contains search). The API always uses the ~ (contains) operator regardless of any operator prefix. Examples: john, admin

group_id
string

Filter by group membership (legacy parameter). Internally converted to is_member_of_group filter with = operator. Value is the group ID.

auth_source_id
string

Filter by authentication source. Undocumented Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1, !1

twofa_scheme
string

Filter by two-factor authentication scheme. Undocumented Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Only available when two-factor authentication is enabled in Redmine settings.

login
string

Filter by login. Undocumented Format: [operator]value Operators: ~ (contains, default), *~ (contains any word), = (exact match), !~ (does not contain), ! (not equal), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~admin, ^john

firstname
string

Filter by first name. Undocumented Format: [operator]value Operators: ~ (contains, default), *~ (contains any word), = (exact match), !~ (does not contain), ! (not equal), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~John, =John

lastname
string

Filter by last name. Undocumented Format: [operator]value Operators: ~ (contains, default), *~ (contains any word), = (exact match), !~ (does not contain), ! (not equal), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~Doe, =Doe

mail
string

Filter by email address. Undocumented Format: [operator]value Operators: ~ (contains, default), *~ (contains any word), = (exact match), !~ (does not contain), ! (not equal), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~example.com, $@example.com

created_on
string

Filter by creation date. Undocumented Format: [operator]value Operators: = (on date), >=, <=, >< (between, pipe-separated), >t- (more than N days ago), <t- (less than N days ago), ><t- (between N and M days ago), t- (N days ago), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), * (any), !* (none) Examples: >=2024-01-01, >t-30, lm

last_login_on
string

Filter by last login date. Undocumented Format: [operator]value Operators: = (on date), >=, <=, >< (between, pipe-separated), >t- (more than N days ago), <t- (less than N days ago), ><t- (between N and M days ago), t- (N days ago), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), * (any), !* (none) Examples: >=2024-01-01, >t-30, !*

admin
string

Filter by admin privilege. Undocumented Format: [operator]value Operators: = (default), ! (not equal) Values: 1 (admin), 0 (non-admin) Examples: 1, !1

header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Create user

https://www.redmine.org/projects/redmine/wiki/Rest_Users#POST
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object
send_information
boolean

Set to true to send an account information email to the user. Not stored; only triggers email delivery.

object (pref)

Responses

Request samples

Content type
application/json
{
  • "user": {
    },
  • "send_information": true,
  • "pref": {
    }
}

Response samples

Content type
application/json
{
  • "user": {
    }
}

Show user

https://www.redmine.org/projects/redmine/wiki/Rest_Users#GET-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
user_id
required
integer
query Parameters
include
Array of strings
Items Enum: "memberships" "groups" "auth_source"

Comma-separated list of associated data to include in the response. Values: memberships (project memberships with roles), groups (groups the user belongs to), auth_source (authentication source information)

header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

Update user

https://www.redmine.org/projects/redmine/wiki/Rest_Users#PUT
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
user_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object
send_information
boolean

Set to true to send an account information email to the user. Not stored; only triggers email delivery.

object (pref)

Responses

Request samples

Content type
application/json
{
  • "user": {
    },
  • "send_information": true,
  • "pref": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete user

https://www.redmine.org/projects/redmine/wiki/Rest_Users#DELETE
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
user_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Show current user

https://www.redmine.org/projects/redmine/wiki/Rest_Users#GET-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
query Parameters
include
Array of strings
Items Enum: "memberships" "groups" "auth_source"

Comma-separated list of associated data to include in the response. Values: memberships (project memberships with roles), groups (groups the user belongs to), auth_source (authentication source information)

header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

Time Entries

Status: Stable, Availability: 1.1

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries

List time entries

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Listing-time-entries
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
query Parameters
offset
integer
limit
integer
nometa
integer
Value: 1
user_id
string

Filter by user. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Special values: me (current user) Examples: 1, me, !*

project_id
string

Filter by project. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Special values: mine (projects where current user is a member), bookmarks (bookmarked projects) Examples: 1|2, mine, !mine

spent_on
string

Filter by date spent. Format: [operator]value Operators: = (on date), >=, <=, >< (between, pipe-separated), >t- (more than N days ago), <t- (less than N days ago), ><t- (between N and M days ago), t- (N days ago), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), * (any), !* (none) Examples: =2024-01-01, >=2024-01-01, ><2024-01-01|2024-12-31, >t-7, t, lw

from
string <date>

Shortcut for spent_on filter. When used with to, filters as between (>=from and <=to). When used alone, filters as >=from. Format: YYYY-MM-DD

to
string <date>

Shortcut for spent_on filter. When used with from, filters as between (>=from and <=to). When used alone, filters as <=to. Format: YYYY-MM-DD

subproject_id
string

Filter by subproject. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1|2, *, !*

issue_id
string

Filter by issue. Format: [operator]value Operators: = (exact match), ~ (issue and its subtasks), * (any), !* (none) Examples: =1, ~1, *, !*

issue.tracker_id
string

Filter by issue's tracker. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2, !3

issue.status_id
string

Filter by issue's status. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2, !3

issue.fixed_version_id
string

Filter by issue's target version. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2, !3

issue.parent_id
string

Filter by issue's parent. Format: [operator]value Operators: = (exact match), ~ (issue and its subtasks), * (any), !* (none) Examples: =1, ~1, *, !*

issue.category_id
string

Filter by issue's category. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1|2, !*

issue.subject
string

Filter by issue's subject. Format: [operator]value Operators: ~ (contains, default), *~ (contains any word), !~ (does not contain), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword, ^prefix, $suffix

user.group
string

Filter by user's group. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1|2, *

user.role
string

Filter by user's role. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1|2, *

author_id
string

Filter by author. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Special values: me (current user) Examples: 1, me, !*

activity_id
string

Filter by activity. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2, !3

project.status
string

Filter by project's status. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Values: 1 (active), 5 (closed) Examples: 1, !5

comments
string

Filter by comments. Format: [operator]value Operators: ~ (contains, default), *~ (contains any word), !~ (does not contain), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword, ^prefix

hours
string

Filter by hours. Format: [operator]value Operators: = (default), >=, <=, >< (between, pipe-separated), * (any), !* (none) Examples: =8, >=4, ><1|8

sort
string
Example: sort=spent_on:desc

Sort order. Comma-separated list of field or field:desc. Default direction is ascending. Examples: spent_on:desc, hours:desc,spent_on

header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "time_entries": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Create time entry

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Creating-a-time-entry
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "time_entry": {
    }
}

Response samples

Content type
application/json
{
  • "time_entry": {
    }
}

Show time entry

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Showing-a-time-entry
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
time_entry_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "time_entry": {
    }
}

Update time entry

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Updating-a-time-entry
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
time_entry_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "time_entry": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete time entry

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Deleting-a-time-entry
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
time_entry_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List time entries by project

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Listing-time-entries
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
query Parameters
offset
integer
limit
integer
nometa
integer
Value: 1
user_id
string

Filter by user. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Special values: me (current user) Examples: 1, me, !*

spent_on
string

Filter by date spent. Format: [operator]value Operators: = (on date), >=, <=, >< (between, pipe-separated), >t- (more than N days ago), <t- (less than N days ago), ><t- (between N and M days ago), t- (N days ago), t (today), ld (yesterday), w (this week), lw (last week), l2w (last 2 weeks), m (this month), lm (last month), y (this year), * (any), !* (none) Examples: =2024-01-01, >=2024-01-01, ><2024-01-01|2024-12-31, >t-7, t, lw

from
string <date>

Shortcut for spent_on filter. When used with to, filters as between (>=from and <=to). When used alone, filters as >=from. Format: YYYY-MM-DD

to
string <date>

Shortcut for spent_on filter. When used with from, filters as between (>=from and <=to). When used alone, filters as <=to. Format: YYYY-MM-DD

subproject_id
string

Filter by subproject. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1|2, *, !*

issue_id
string

Filter by issue. Format: [operator]value Operators: = (exact match), ~ (issue and its subtasks), * (any), !* (none) Examples: =1, ~1, *, !*

issue.tracker_id
string

Filter by issue's tracker. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2, !3

issue.status_id
string

Filter by issue's status. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2, !3

issue.fixed_version_id
string

Filter by issue's target version. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2, !3

issue.parent_id
string

Filter by issue's parent. Format: [operator]value Operators: = (exact match), ~ (issue and its subtasks), * (any), !* (none) Examples: =1, ~1, *, !*

issue.category_id
string

Filter by issue's category. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1|2, !*

issue.subject
string

Filter by issue's subject. Format: [operator]value Operators: ~ (contains, default), *~ (contains any word), !~ (does not contain), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword, ^prefix, $suffix

user.group
string

Filter by user's group. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1|2, *

user.role
string

Filter by user's role. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Examples: 1|2, *

author_id
string

Filter by author. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal), * (any), !* (none) Special values: me (current user) Examples: 1, me, !*

activity_id
string

Filter by activity. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Examples: 1|2, !3

project.status
string

Filter by project's status. Format: [operator]value[|value2|...] Operators: = (default), ! (not equal) Values: 1 (active), 5 (closed) Examples: 1, !5

comments
string

Filter by comments. Format: [operator]value Operators: ~ (contains, default), *~ (contains any word), !~ (does not contain), ^ (starts with), $ (ends with), * (any), !* (none) Examples: ~keyword, ^prefix

hours
string

Filter by hours. Format: [operator]value Operators: = (default), >=, <=, >< (between, pipe-separated), * (any), !* (none) Examples: =8, >=4, ><1|8

sort
string
Example: sort=spent_on:desc

Sort order. Comma-separated list of field or field:desc. Default direction is ascending. Examples: spent_on:desc, hours:desc,spent_on

header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "time_entries": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Create time entry under project

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Creating-a-time-entry
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "time_entry": {
    }
}

Response samples

Content type
application/json
{
  • "time_entry": {
    }
}

Create time entry under issue

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Creating-a-time-entry
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "time_entry": {
    }
}

Response samples

Content type
application/json
{
  • "time_entry": {
    }
}

News

Status: Prototype, Availability: 1.1

https://www.redmine.org/projects/redmine/wiki/Rest_News

List news

https://www.redmine.org/projects/redmine/wiki/Rest_News#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
query Parameters
offset
integer
limit
integer
nometa
integer
Value: 1
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "news": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Show news

Undocumented: This operation is not listed in the official documentation.

Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
news_id
required
integer
query Parameters
include
Array of strings
Items Enum: "attachments" "comments"

Comma-separated list of associated data to include in the response. Values: attachments (file attachments), comments (comments/replies on the news item)

header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "news": {
    }
}

Update news

Undocumented: This operation is not listed in the official documentation.

Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
news_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "news": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete news

Undocumented: This operation is not listed in the official documentation.

Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
news_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

List news by project

https://www.redmine.org/projects/redmine/wiki/Rest_News#GET-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
query Parameters
offset
integer
limit
integer
nometa
integer
Value: 1
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "news": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Create news

Undocumented: This operation is not listed in the official documentation.

Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "news": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Issue Relations

Status: Alpha, Availability: 1.3

https://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations

List issue relations

https://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "relations": [
    ]
}

Create issue relation

https://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#POST
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "relation": {
    }
}

Response samples

Content type
application/json
{
  • "relation": {
    }
}

Show issue relation

https://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#GET-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_relation_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "relation": {
    }
}

Delete issue relation

https://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#DELETE
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_relation_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Versions

Status: Alpha, Availability: 1.3

https://www.redmine.org/projects/redmine/wiki/Rest_Versions

List versions by project

https://www.redmine.org/projects/redmine/wiki/Rest_Versions#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
query Parameters
nometa
integer
Value: 1
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ],
  • "total_count": 0
}

Create version

https://www.redmine.org/projects/redmine/wiki/Rest_Versions#POST
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "version": {
    }
}

Response samples

Content type
application/json
{
  • "version": {
    }
}

Show version

https://www.redmine.org/projects/redmine/wiki/Rest_Versions#GET-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
version_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "version": {
    }
}

Update version

https://www.redmine.org/projects/redmine/wiki/Rest_Versions#PUT
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
version_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "version": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete version

https://www.redmine.org/projects/redmine/wiki/Rest_Versions#DELETE
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
version_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Wiki Pages

Status: Alpha, Availability: 2.2

https://www.redmine.org/projects/redmine/wiki/Rest_WikiPages

List wiki pages

https://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Getting-the-pages-list-of-a-wiki
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "wiki_pages": [
    ]
}

Show wiki page

https://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Getting-a-wiki-page
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
wiki_page_title
required
string
query Parameters
include
Array of strings
Items Value: "attachments"

Comma-separated list of associated data to include in the response. Values: attachments (file attachments)

header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "wiki_page": {
    }
}

Create or update wiki page

https://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Creating-or-updating-a-wiki-page
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
wiki_page_title
required
string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "wiki_page": {
    }
}

Response samples

Content type
application/json
{
  • "wiki_page": {
    }
}

Delete wiki page

https://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Deleting-a-wiki-page
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
wiki_page_title
required
string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Show wiki page by specific version

https://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Getting-an-old-version-of-a-wiki-page
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
wiki_page_title
required
string
version_id
required
integer
query Parameters
include
Array of strings
Items Value: "attachments"

Comma-separated list of associated data to include in the response. Values: attachments (file attachments)

header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "wiki_page": {
    }
}

Queries

Status: Alpha, Availability: 1.3

https://www.redmine.org/projects/redmine/wiki/Rest_Queries

List queries

https://www.redmine.org/projects/redmine/wiki/Rest_Queries#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
query Parameters
offset
integer
limit
integer
nometa
integer
Value: 1
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "queries": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Attachments

Status: Beta, Availability: 1.3

https://www.redmine.org/projects/redmine/wiki/Rest_Attachments

Show attachment

https://www.redmine.org/projects/redmine/wiki/Rest_Attachments#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
attachment_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "attachment": {
    }
}

Update attachment

https://www.redmine.org/projects/redmine/wiki/Rest_Attachments#PATCH
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
attachment_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "attachment": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete attachment

https://www.redmine.org/projects/redmine/wiki/Rest_Attachments#DELETE
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
attachment_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Download attachment file

Undocumented: This operation is not listed in the official documentation.

Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
attachment_id
required
integer
filename
required
string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Download thumbnail

Undocumented: This operation is not listed in the official documentation.

Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
attachment_id
required
integer
query Parameters
size
integer

Desired thumbnail size in pixels (max 800). Rounded up to the nearest 50px increment. If not specified, the configured default thumbnail size is used.

header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Upload attachment file

https://www.redmine.org/projects/redmine/wiki/Rest_api#Attaching-files
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
query Parameters
filename
string

Filename for the uploaded file. If not provided, a random hexadecimal name is generated.

content_type
string

MIME type of the file (e.g., application/pdf, image/png). If not provided, auto-detected from the filename.

header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/octet-stream
string <binary>

Responses

Response samples

Content type
application/json
{
  • "upload": {
    }
}

Issue Statuses

Status: Alpha, Availability: 1.3

https://www.redmine.org/projects/redmine/wiki/Rest_IssueStatuses

List issue statuses

https://www.redmine.org/projects/redmine/wiki/Rest_IssueStatuses#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "issue_statuses": [
    ]
}

Trackers

Status: Alpha, Availability: 1.3

https://www.redmine.org/projects/redmine/wiki/Rest_Trackers

List trackers

https://www.redmine.org/projects/redmine/wiki/Rest_Trackers#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "trackers": [
    ]
}

Enumerations

Status: Alpha, Availability: 2.2

https://www.redmine.org/projects/redmine/wiki/Rest_Enumerations

List issue priorities

https://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "issue_priorities": [
    ]
}

List time entry activities

https://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#GET-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "time_entry_activities": [
    ]
}

List document categories

https://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#GET-3
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "document_categories": [
    ]
}

Issue Categories

Status: Alpha, Availability: 1.3

https://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories

List issue categories

https://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
query Parameters
nometa
integer
Value: 1
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "issue_categories": [
    ],
  • "total_count": 0
}

Create issue category

https://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#POST
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "issue_category": {
    }
}

Response samples

Content type
application/json
{
  • "issue_category": {
    }
}

Show issue category

https://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#GET-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_category_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "issue_category": {
    }
}

Update issue category

https://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#PUT
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_category_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "issue_category": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete issue category

https://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#DELETE
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
issue_category_id
required
integer
query Parameters
reassign_to_id
integer

ID of another issue category to reassign issues to before deleting this category. If the category has associated issues and this parameter is not provided, the issues will have their category unset.

header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Roles

Status: Alpha, Availability: 1.4

https://www.redmine.org/projects/redmine/wiki/Rest_Roles

List roles

https://www.redmine.org/projects/redmine/wiki/Rest_Roles#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Show role

https://www.redmine.org/projects/redmine/wiki/Rest_Roles#GET-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
role_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "role": {
    }
}

Groups

Status: Alpha, Availability: 2.1

https://www.redmine.org/projects/redmine/wiki/Rest_Groups

List groups

https://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
query Parameters
builtin
string
Value: "1"

Include built-in groups (e.g., "Anonymous", "Non member") in the response. Set to 1 to include built-in groups. Without this parameter, only user-created groups are returned.

header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Create group

https://www.redmine.org/projects/redmine/wiki/Rest_Groups#POST
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "group": {
    }
}

Response samples

Content type
application/json
{
  • "group": {
    }
}

Show group

https://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
group_id
required
integer
query Parameters
include
Array of strings
Items Enum: "users" "memberships"

Comma-separated list of associated data to include in the response. Values: users (list of users in the group), memberships (project memberships with roles)

header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "group": {
    }
}

Update group

https://www.redmine.org/projects/redmine/wiki/Rest_Groups#PUT
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
group_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "group": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Delete group

https://www.redmine.org/projects/redmine/wiki/Rest_Groups#DELETE
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
group_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Add user to group

https://www.redmine.org/projects/redmine/wiki/Rest_Groups#POST-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
group_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
user_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "user_id": 0
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Remove user from group

https://www.redmine.org/projects/redmine/wiki/Rest_Groups#DELETE-2
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
group_id
required
integer
user_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Custom Fields

Status: Alpha, Availability: 2.4

https://www.redmine.org/projects/redmine/wiki/Rest_CustomFields

List custom fields

https://www.redmine.org/projects/redmine/wiki/Rest_CustomFields#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "custom_fields": [
    ]
}

Search

Status: Alpha, Availability: 3.3

https://www.redmine.org/projects/redmine/wiki/Rest_Search

Search

https://www.redmine.org/projects/redmine/wiki/Rest_Search#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
query Parameters
limit
integer
offset
integer
nometa
integer
Value: 1
q
required
string

Search query string. Tokenized into words for matching. When all_words is enabled (default), all tokens must match. Otherwise, any token can match.

scope
string
Enum: "all" "my_projects" "bookmarks" "subprojects"

Search scope. Values: all (all projects), my_projects (projects where current user is a member), bookmarks (bookmarked projects), subprojects (include subprojects, only effective for project-scoped search)

all_words
string

Require all words to match. Default is true (all words must match). Set to empty string to disable (any word matches). Any non-empty value enables this option.

titles_only
string

Search titles only. Default is false. Any non-empty value enables this option.

issues
integer
Value: 1

Include issues in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

news
integer
Value: 1

Include news in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

wiki_pages
integer
Value: 1

Include wiki pages in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

projects
integer
Value: 1

Include projects in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched. Not available when searching within a specific project.

documents
integer
Value: 1

Include documents in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

changesets
integer
Value: 1

Include changesets in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

messages
integer
Value: 1

Include forum messages in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

open_issues
string

Only return open issues. Default is false. Any non-empty value enables this option.

attachments
string
Enum: "0" "1" "only"

Search attachments. Default is 0 (do not search attachments). Values: 0 (disabled), 1 (search attachments and content), only (search attachments only)

header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Search within project

https://www.redmine.org/projects/redmine/wiki/Rest_Search#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
query Parameters
limit
integer
offset
integer
nometa
integer
Value: 1
q
required
string

Search query string. Tokenized into words for matching. When all_words is enabled (default), all tokens must match. Otherwise, any token can match.

scope
string
Value: "subprojects"

Search scope. Values: subprojects (include subprojects of the specified project) When not specified, only the specified project is searched.

all_words
string

Require all words to match. Default is true (all words must match). Set to empty string to disable (any word matches). Any non-empty value enables this option.

titles_only
string

Search titles only. Default is false. Any non-empty value enables this option.

issues
integer
Value: 1

Include issues in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

news
integer
Value: 1

Include news in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

wiki_pages
integer
Value: 1

Include wiki pages in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

documents
integer
Value: 1

Include documents in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

changesets
integer
Value: 1

Include changesets in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

messages
integer
Value: 1

Include forum messages in search results. Any non-empty value enables this search type. If no search type parameters are specified, all types are searched.

open_issues
string

Only return open issues. Default is false. Any non-empty value enables this option.

attachments
string
Enum: "0" "1" "only"

Search attachments. Default is 0 (do not search attachments). Values: 0 (disabled), 1 (search attachments and content), only (search attachments only)

header Parameters
X-Redmine-Switch-User
string
Example: jsmith
X-Redmine-Nometa
integer
Value: 1

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "total_count": 0,
  • "offset": 0,
  • "limit": 0
}

Files

Status: Alpha, Availability: 3.4

https://www.redmine.org/projects/redmine/wiki/Rest_Files

List files

https://www.redmine.org/projects/redmine/wiki/Rest_Files#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Create file

https://www.redmine.org/projects/redmine/wiki/Rest_Files#POST
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "file": {
    }
}

My Account

Status: Alpha, Availability: 4.1

https://www.redmine.org/projects/redmine/wiki/Rest_MyAccount

Show my account

https://www.redmine.org/projects/redmine/wiki/Rest_MyAccount#GET
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

Update my account

https://www.redmine.org/projects/redmine/wiki/Rest_MyAccount#PUT
Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object
object (pref)

Responses

Request samples

Content type
application/json
{
  • "user": {
    },
  • "pref": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Update journal

Undocumented: This operation is not listed in the official documentation.

Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
journal_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "journal": {
    }
}

Repositories

Undocumented

Add related issue

Undocumented: This operation is not listed in the official documentation.

Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
required
integer or string
revision
required
string
header Parameters
X-Redmine-Switch-User
string
Example: jsmith
Request Body schema: application/json
issue_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "issue_id": 0
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Remove related issue

Undocumented: This operation is not listed in the official documentation.

Authorizations:
BasicApiKeyApiKeyInQueryOAuth2
path Parameters
format
required
string
Enum: "json" "xml"
required
integer or string
required
integer or string
revision
required
string
issue_id
required
integer
header Parameters
X-Redmine-Switch-User
string
Example: jsmith

Responses