Redmine API (0.16.0)

Download OpenAPI specification:Download

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

Unofficial OpenAPI specification for the Redmine API.

Redmine API Official Developer Guide

Issues

Status: Stable, Availablity: 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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

query Parameters

offset	integer
limit	integer
nometa	integer Value: 1
sort	string Example: sort=id:desc
include	Array of strings Items Enum: "attachments" "relations"
issue_id	Array of strings
project_id	Array of strings
subproject_id	Array of strings
tracker_id	Array of strings
status_id	Array of strings
assigned_to_id	Array of strings
parent_id	Array of strings
	object Example: cf_0=string
author_id	Array of strings
member_of_group	Array of strings
assigned_to_role	Array of strings
fixed_version_id	Array of strings
fixed_version.due_date	string
fixed_version.status	Array of strings
category_id	Array of strings
subject	string
description	string
notes	string
created_on	string
updated_on	string
closed_on	string
start_date	string
due_date	string
estimated_hours	string
spent_time	string
done_ratio	string
is_private	string
attachment	string
attachment_description	string
watcher_id	Array of strings
updated_by	Array of strings
last_updated_by	Array of strings
project.status	integer
relation_type	Array of strings
child_id	Array of strings
query_id	integer

header Parameters

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

Responses

Response samples

200

Content type

application/json

{"issues": [{"id": 0,
"project": {"id": 0,
"name": "string"
},
"tracker": {"id": 0,
"name": "string"
},
"status": {"id": 0,
"name": "string",
"is_closed": true
},
"priority": {"id": 0,
"name": "string"
},
"author": {"id": 0,
"name": "string"
},
"assigned_to": {"id": 0,
"name": "string"
},
"category": {"id": 0,
"name": "string"
},
"subject": "string",
"description": "string",
"start_date": "string",
"due_date": "string",
"done_ratio": 0,
"is_private": true,
"estimated_hours": 0,
"total_estimated_hours": 0,
"spent_hours": 0,
"total_spent_hours": 0,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"closed_on": "2019-08-24T14:15:22Z"
}
],
"total_count": 0,
"offset": 0,
"limit": 0
}

Create issue

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Creating-an-issue

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"issue": {"project_id": 0,
"tracker_id": 0,
"status_id": 0,
"priority_id": 0,
"subject": "string",
"description": "string",
"start_date": "2019-08-24",
"due_date": "2019-08-24",
"done_ratio": 100,
"category_id": 0,
"fixed_version_id": 0,
"assigned_to_id": 0,
"parent_issue_id": 0,
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
},
"watcher_user_ids": [0
],
"is_private": true,
"estimated_hours": 0,
"uploads": [{"token": "string",
"filename": "string",
"description": "string",
"content_type": "string"
}
]
}
}

Response samples

201

Content type

application/json

{"issue": {"id": 0,
"project": {"id": 0,
"name": "string"
},
"tracker": {"id": 0,
"name": "string"
},
"status": {"id": 0,
"name": "string",
"is_closed": true
},
"priority": {"id": 0,
"name": "string"
},
"author": {"id": 0,
"name": "string"
},
"assigned_to": {"id": 0,
"name": "string"
},
"category": {"id": 0,
"name": "string"
},
"subject": "string",
"description": "string",
"start_date": "string",
"due_date": "string",
"done_ratio": 0,
"is_private": true,
"estimated_hours": 0,
"total_estimated_hours": 0,
"spent_hours": 0,
"total_spent_hours": 0,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"closed_on": "2019-08-24T14:15:22Z"
}
}

Show issue

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Showing-an-issue

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"issue": {"id": 0,
"project": {"id": 0,
"name": "string"
},
"tracker": {"id": 0,
"name": "string"
},
"status": {"id": 0,
"name": "string",
"is_closed": true
},
"priority": {"id": 0,
"name": "string"
},
"author": {"id": 0,
"name": "string"
},
"assigned_to": {"id": 0,
"name": "string"
},
"category": {"id": 0,
"name": "string"
},
"subject": "string",
"description": "string",
"start_date": "string",
"due_date": "string",
"done_ratio": 0,
"is_private": true,
"estimated_hours": 0,
"total_estimated_hours": 0,
"spent_hours": 0,
"total_spent_hours": 0,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"closed_on": "2019-08-24T14:15:22Z",
"changesets": ["string"
],
"children": [{"id": 0,
"tracker": {"id": 0,
"name": "string"
},
"subject": "string"
}
],
"attachments": [{"id": 0,
"filename": "string",
"filesize": 0,
"content_type": "string",
"description": "string",
"content_url": "string",
"author": {"id": 0,
"name": "string"
},
"created_on": "string",
"thumbnail_url": "string"
}
],
"relations": [{"id": 0,
"issue_id": 0,
"issue_to_id": 0,
"relation_type": "string",
"delay": 0
}
],
"journals": [{"id": 0,
"user": {"id": 0,
"name": "string"
},
"notes": "string",
"created_on": "2019-08-24T14:15:22Z",
"private_notes": true,
"details": [{"property": "string",
"name": "string",
"old_value": "string",
"new_value": "string"
}
]
}
],
"watchers": [{"id": 0,
"name": "string"
}
],
"allowed_statuses": [{"id": 0,
"name": "string",
"is_closed": true
}
]
}
}

Update issue

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Updating-an-issue

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"issue": {"project_id": 0,
"tracker_id": 0,
"status_id": 0,
"priority_id": 0,
"subject": "string",
"description": "string",
"start_date": "2019-08-24",
"due_date": "2019-08-24",
"done_ratio": 100,
"category_id": 0,
"fixed_version_id": 0,
"assigned_to_id": 0,
"parent_issue_id": 0,
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
},
"watcher_user_ids": [0
],
"is_private": true,
"estimated_hours": 0,
"notes": "string",
"private_notes": "string",
"uploads": [{"token": "string",
"filename": "string",
"description": "string",
"content_type": "string"
}
]
}
}

Delete issue

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Deleting-an-issue

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
issue_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Add watcher

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Adding-a-watcher

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"user_id": 0
}

Remove watcher

https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Removing-a-watcher

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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, Availablity: 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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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"
status	Array of integers
id	Array of strings
name	string
description	string
parent_id	Array of strings
is_public	Array of strings Items Enum: "0" "1"
created_on	string

header Parameters

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

Responses

Response samples

200

Content type

application/json

{"projects": [{"id": 0,
"name": "string",
"identifier": "string",
"description": "string",
"parent": {"id": 0,
"name": "string"
},
"status": 0,
"is_public": true,
"inherit_members": true,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"trackers": [{"id": 0,
"name": "string"
}
],
"issue_categories": [{"id": 0,
"name": "string"
}
],
"time_entry_activities": [{"id": 0,
"name": "string"
}
],
"enabled_modules": [{"id": 0,
"name": "string"
}
],
"issue_custom_fields": [{"id": 0,
"name": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z"
}
],
"total_count": 0,
"offset": 0,
"limit": 0
}

Crete project

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Creating-a-project

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"project": {"name": "string",
"identifier": "string",
"description": "string",
"homepage": "string",
"is_public": true,
"parent_id": 0,
"inherit_members": true,
"default_assigned_to_id": 0,
"default_version_id": 0,
"tracker_ids": [0
],
"enabled_module_names": ["string"
],
"issue_custom_field_ids": [0
],
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
}
}
}

Response samples

201
422

Content type

application/json

{"project": {"id": 0,
"name": "string",
"identifier": "string",
"description": "string",
"homepage": "string",
"parent": {"id": 0,
"name": "string"
},
"status": 0,
"is_public": true,
"inherit_members": true,
"default_version": {"id": 0,
"name": "string"
},
"default_assignee": {"id": 0,
"name": "string"
},
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"trackers": [{"id": 0,
"name": "string"
}
],
"issue_categories": [{"id": 0,
"name": "string"
}
],
"time_entry_activities": [{"id": 0,
"name": "string"
}
],
"enabled_modules": [{"id": 0,
"name": "string"
}
],
"issue_custom_fields": [{"id": 0,
"name": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z"
}
}

Show project

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Showing-a-project

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

query Parameters

include

Array of strings

Items Enum: "trackers" "issue_categories" "time_entry_activities" "enabled_modules" "issue_custom_fields"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"project": {"id": 0,
"name": "string",
"identifier": "string",
"description": "string",
"homepage": "string",
"parent": {"id": 0,
"name": "string"
},
"status": 0,
"is_public": true,
"inherit_members": true,
"default_version": {"id": 0,
"name": "string"
},
"default_assignee": {"id": 0,
"name": "string"
},
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"trackers": [{"id": 0,
"name": "string"
}
],
"issue_categories": [{"id": 0,
"name": "string"
}
],
"time_entry_activities": [{"id": 0,
"name": "string"
}
],
"enabled_modules": [{"id": 0,
"name": "string"
}
],
"issue_custom_fields": [{"id": 0,
"name": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z"
}
}

Update project

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Updating-a-project

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"project": {"name": "string",
"description": "string",
"homepage": "string",
"is_public": true,
"parent_id": 0,
"inherit_members": true,
"default_assigned_to_id": 0,
"default_version_id": 0,
"tracker_ids": [0
],
"enabled_module_names": ["string"
],
"issue_custom_field_ids": [0
],
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
}
}
}

Delete project

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Deleting-a-project

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Unarchive project

https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Unarchiving-a-project

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Close project

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Reopen project

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Project Memberships

Status: Alpha, Availablity: 1.4

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

List memberships

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

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

200

Content type

application/json

{"memberships": [{"id": 0,
"project": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"name": "string"
},
"group": {"id": 0,
"name": "string"
},
"roles": [{"id": 0,
"name": "string"
}
]
}
],
"total_count": 0,
"offset": 0,
"limit": 0
}

Create membership

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Request Body schema: application/json

required

object

Responses

Request samples

Payload

Content type

application/json

{"membership": {"user_id": 0,
"role_ids": [0
]
}
}

Response samples

201

Content type

application/json

{"membership": {"id": 0,
"project": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"name": "string"
},
"group": {"id": 0,
"name": "string"
},
"roles": [{"id": 0,
"name": "string"
}
]
}
}

Show membership

https://www.redmine.org/projects/redmine/wiki/Rest_Memberships#GET-2

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
membership_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"membership": {"id": 0,
"project": {"id": 0,
"name": "string"
},
"user": {"id": 0,
"name": "string"
},
"group": {"id": 0,
"name": "string"
},
"roles": [{"id": 0,
"name": "string"
}
]
}
}

Update membership

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"membership": {"role_ids": [0
]
}
}

Response samples

422

Content type

application/json

{"errors": ["string"
]
}

Delete membership

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
membership_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Users

Status: Stable, Availablity: 1.1

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

List users

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

query Parameters

offset	integer
limit	integer
nometa	integer Value: 1
status	integer
name	string
group_id	integer

header Parameters

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

Responses

Response samples

200

Content type

application/json

{"users": [{"id": 0,
"login": "string",
"admin": true,
"firstname": "string",
"lastname": "string",
"mail": "string",
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"last_login_on": "2019-08-24T14:15:22Z",
"passwd_changed_on": "2019-08-24T14:15:22Z",
"twofa_scheme": { },
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
]
}
],
"total_count": 0,
"offset": 0,
"limit": 0
}

Create user

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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
	object (pref)

Responses

Request samples

Payload

Content type

application/json

{"user": {"login": "string",
"admin": true,
"password": "string",
"firstname": "string",
"lastname": "string",
"mail": "string",
"language": "string",
"auth_source_id": 0,
"mail_notification": "all",
"notified_project_ids": [0
],
"must_change_passwd": true,
"generate_password": true,
"status": 0,
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
}
},
"send_information": true,
"pref": {"hide_mail": true,
"time_zone": "string",
"comments_sorting": "asc",
"warn_on_leaving_unsaved": true,
"no_self_notified": true,
"notify_about_high_priority_issues": true,
"textarea_font": "monospace",
"recently_used_projects": 0,
"history_default_tab": "notes",
"toolbar_language_options": "string",
"default_issue_query": 0,
"default_project_query": 0,
"auto_watch_on": "issue_contributed_to"
}
}

Response samples

201
422

Content type

application/json

{"user": {"id": 0,
"login": "string",
"admin": true,
"firstname": "string",
"lastname": "string",
"mail": "string",
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"last_login_on": "2019-08-24T14:15:22Z",
"passwd_changed_on": "2019-08-24T14:15:22Z",
"twofa_scheme": { },
"api_key": "string",
"status": 0,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"groups": [{"id": 0,
"name": "string"
}
],
"memberships": [{"id": 0,
"project": {"id": 0,
"name": "string"
},
"roles": [{"id": 0,
"name": "string",
"inherited": true
}
]
}
]
}
}

Show user

https://www.redmine.org/projects/redmine/wiki/Rest_Users#GET-2

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
user_id required	integer

query Parameters

include

Array of strings

Items Enum: "memberships" "groups"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"user": {"id": 0,
"login": "string",
"admin": true,
"firstname": "string",
"lastname": "string",
"mail": "string",
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"last_login_on": "2019-08-24T14:15:22Z",
"passwd_changed_on": "2019-08-24T14:15:22Z",
"twofa_scheme": { },
"api_key": "string",
"status": 0,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"groups": [{"id": 0,
"name": "string"
}
],
"memberships": [{"id": 0,
"project": {"id": 0,
"name": "string"
},
"roles": [{"id": 0,
"name": "string",
"inherited": true
}
]
}
]
}
}

Update user

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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
	object (pref)

Responses

Request samples

Payload

Content type

application/json

{"user": {"login": "string",
"admin": true,
"password": "string",
"firstname": "string",
"lastname": "string",
"mail": "string",
"language": "string",
"auth_source_id": 0,
"mail_notification": "all",
"notified_project_ids": [0
],
"must_change_passwd": true,
"generate_password": true,
"status": 0,
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
},
"group_ids": [0
]
},
"send_information": true,
"pref": {"hide_mail": true,
"time_zone": "string",
"comments_sorting": "asc",
"warn_on_leaving_unsaved": true,
"no_self_notified": true,
"notify_about_high_priority_issues": true,
"textarea_font": "monospace",
"recently_used_projects": 0,
"history_default_tab": "notes",
"toolbar_language_options": "string",
"default_issue_query": 0,
"default_project_query": 0,
"auto_watch_on": "issue_contributed_to"
}
}

Response samples

422

Content type

application/json

{"errors": ["string"
]
}

Delete user

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
user_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Show current user

https://www.redmine.org/projects/redmine/wiki/Rest_Users#GET-2

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

query Parameters

include

Array of strings

Items Enum: "memberships" "groups"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"user": {"id": 0,
"login": "string",
"admin": true,
"firstname": "string",
"lastname": "string",
"mail": "string",
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"last_login_on": "2019-08-24T14:15:22Z",
"passwd_changed_on": "2019-08-24T14:15:22Z",
"twofa_scheme": { },
"api_key": "string",
"status": 0,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"groups": [{"id": 0,
"name": "string"
}
],
"memberships": [{"id": 0,
"project": {"id": 0,
"name": "string"
},
"roles": [{"id": 0,
"name": "string",
"inherited": true
}
]
}
]
}
}

Time Entries

Status: Stable, Availablity: 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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

query Parameters

offset	integer
limit	integer
nometa	integer Value: 1
user_id	Array of strings
project_id	Array of strings
spent_on	string <date>
from	string <date>
to	string <date>
subproject_id	Array of strings
issue_id	Array of strings
issue.tracker_id	Array of strings
issue.status_id	Array of strings
issue.fixed_version_id	Array of strings
issue.category_id	Array of strings
author_id	Array of strings
activity_id	Array of strings
project.status	Array of strings
comments	string
hours	string
sort	string Example: sort=spent_on:desc

header Parameters

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

Responses

Response samples

200

Content type

application/json

{"time_entries": [{"id": 0,
"project": {"id": 0,
"name": "string"
},
"issue": {"id": 0
},
"user": {"id": 0,
"name": "string"
},
"activity": {"id": 0,
"name": "string"
},
"hours": 0,
"comments": "string",
"spent_on": "2019-08-24",
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
]
}
],
"total_count": 0,
"offset": 0,
"limit": 0
}

Create time entry

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Creating-a-time-entry

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"time_entry": {"issue_id": 0,
"project_id": 0,
"spent_on": "2019-08-24",
"hours": 0,
"activity_id": 0,
"comments": "string",
"user_id": 0,
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
}
}
}

Response samples

201
422

Content type

application/json

{"time_entry": {"id": 0,
"project": {"id": 0,
"name": "string"
},
"issue": {"id": 0
},
"user": {"id": 0,
"name": "string"
},
"activity": {"id": 0,
"name": "string"
},
"hours": 0,
"comments": "string",
"spent_on": "2019-08-24",
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
]
}
}

Show time entry

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Showing-a-time-entry

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

200

Content type

application/json

{"time_entry": {"id": 0,
"project": {"id": 0,
"name": "string"
},
"issue": {"id": 0
},
"user": {"id": 0,
"name": "string"
},
"activity": {"id": 0,
"name": "string"
},
"hours": 0,
"comments": "string",
"spent_on": "2019-08-24",
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
]
}
}

Update time entry

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Updating-a-time-entry

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"time_entry": {"issue_id": 0,
"project_id": 0,
"spent_on": "2019-08-24",
"hours": 0,
"activity_id": 0,
"comments": "string",
"user_id": 0,
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
}
}
}

Response samples

422

Content type

application/json

{"errors": ["string"
]
}

Delete time entry

https://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries#Deleting-a-time-entry

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
time_entry_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

News

Status: Prototype, Availablity: 1.1

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

List news

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

200

Content type

application/json

{"news": [{"id": 0,
"project": {"id": 0,
"name": "string"
},
"author": {"id": 0,
"name": "string"
},
"title": "string",
"summary": "string",
"description": "string",
"created_on": "2019-08-24T14:15:22Z",
"attachments": [{"id": 0,
"filename": "string",
"filesize": 0,
"content_type": "string",
"description": "string",
"content_url": "string",
"thumbnail_url": "string",
"author": {"id": 0,
"name": "string"
},
"created_on": "string"
}
],
"comments": [{"id": 0,
"author": {"id": 0,
"name": "string"
},
"content": "string"
}
]
}
],
"total_count": 0,
"offset": 0,
"limit": 0
}

Show news

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
news_id required	integer

query Parameters

include

Array of strings

Items Enum: "attachments" "comments"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"news": {"id": 0,
"project": {"id": 0,
"name": "string"
},
"author": {"id": 0,
"name": "string"
},
"title": "string",
"summary": "string",
"description": "string",
"created_on": "2019-08-24T14:15:22Z",
"attachments": [{"id": 0,
"filename": "string",
"filesize": 0,
"content_type": "string",
"description": "string",
"content_url": "string",
"thumbnail_url": "string",
"author": {"id": 0,
"name": "string"
},
"created_on": "string"
}
],
"comments": [{"id": 0,
"author": {"id": 0,
"name": "string"
},
"content": "string"
}
]
}
}

Update news

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"news": {"title": "string",
"summary": "string",
"description": "string",
"uploads": [{"token": "string",
"filename": "string",
"description": "string",
"content_type": "string"
}
]
}
}

Delete news

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

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

200

Content type

application/json

{"news": [{"id": 0,
"project": {"id": 0,
"name": "string"
},
"author": {"id": 0,
"name": "string"
},
"title": "string",
"summary": "string",
"description": "string",
"created_on": "2019-08-24T14:15:22Z",
"attachments": [{"id": 0,
"filename": "string",
"filesize": 0,
"content_type": "string",
"description": "string",
"content_url": "string",
"thumbnail_url": "string",
"author": {"id": 0,
"name": "string"
},
"created_on": "string"
}
],
"comments": [{"id": 0,
"author": {"id": 0,
"name": "string"
},
"content": "string"
}
]
}
],
"total_count": 0,
"offset": 0,
"limit": 0
}

Create news

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Request Body schema: application/json

required

object

Responses

Request samples

Payload

Content type

application/json

{"news": {"title": "string",
"summary": "string",
"description": "string",
"uploads": [{"token": "string",
"filename": "string",
"description": "string",
"content_type": "string"
}
]
}
}

Issue Relations

Status: Alpha, Availablity: 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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
issue_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"relations": [{"id": 0,
"issue_id": 0,
"issue_to_id": 0,
"relation_type": "string",
"delay": 0
}
]
}

Create issue relation

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"relation": {"issue_to_id": 0,
"relation_type": "relates",
"delay": 0
}
}

Response samples

201
422

Content type

application/json

{"relation": {"id": 0,
"issue_id": 0,
"issue_to_id": 0,
"relation_type": "string",
"delay": 0
}
}

Show issue relation

https://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#GET-2

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

200

Content type

application/json

{"relation": {"id": 0,
"issue_id": 0,
"issue_to_id": 0,
"relation_type": "string",
"delay": 0
}
}

Delete issue relation

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

422

Content type

application/json

{"errors": ["string"
]
}

Versions

Status: Alpha, Availablity: 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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

query Parameters

nometa

integer

Value: 1

header Parameters

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

Responses

Response samples

200

Content type

application/json

{"versions": [{"id": 0,
"project": {"id": 0,
"name": "string"
},
"name": "string",
"description": "string",
"status": "open",
"due_date": "2019-08-24",
"sharing": "none",
"wiki_page_title": "string",
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z"
}
],
"total_count": 0
}

Create version

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Request Body schema: application/json

required

object

Responses

Request samples

Payload

Content type

application/json

{"version": {"name": "string",
"status": "open",
"sharing": "none",
"due_date": "2019-08-24",
"description": "string",
"wiki_page_title": "string",
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
}
}
}

Response samples

201
422

Content type

application/json

{"version": {"id": 0,
"project": {"id": 0,
"name": "string"
},
"name": "string",
"description": "string",
"status": "open",
"due_date": "2019-08-24",
"sharing": "none",
"wiki_page_title": "string",
"estimated_hours": 0,
"spent_hours": 0,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z"
}
}

Show version

https://www.redmine.org/projects/redmine/wiki/Rest_Versions#GET-2

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
version_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"version": {"id": 0,
"project": {"id": 0,
"name": "string"
},
"name": "string",
"description": "string",
"status": "open",
"due_date": "2019-08-24",
"sharing": "none",
"wiki_page_title": "string",
"estimated_hours": 0,
"spent_hours": 0,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z"
}
}

Update version

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"version": {"name": "string",
"status": "open",
"sharing": "none",
"due_date": "2019-08-24",
"description": "string",
"wiki_page_title": "string",
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
}
}
}

Response samples

422

Content type

application/json

{"errors": ["string"
]
}

Delete version

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
version_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

422

Content type

application/json

{"errors": ["string"
]
}

Wiki Pages

Status: Alpha, Availablity: 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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"wiki_pages": [{"title": 0,
"parent": {"title": "string"
},
"version": 0,
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z"
}
]
}

Show wiki page

https://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Getting-a-wiki-page

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer
wiki_page_title required	string

query Parameters

include

string

Value: "attachments"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"wiki_page": {"title": "string",
"parent": {"title": "string"
},
"text": "string",
"version": 0,
"author": {"id": 0,
"name": "string"
},
"comments": "string",
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"attachments": [{"id": 0,
"filename": "string",
"filesize": 0,
"content_type": "string",
"description": "string",
"content_url": "string",
"thumbnail_url": "string",
"author": {"id": 0,
"name": "string"
},
"created_on": "string"
}
]
}
}

Create or update wiki page

https://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Creating-or-updating-a-wiki-page

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer
wiki_page_title required	string

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"wiki_page": {"text": "string",
"comments": "string",
"version": 0
}
}

Response samples

201
409
422

Content type

application/json

{"wiki_page": {"title": "string",
"parent": {"title": "string"
},
"text": "string",
"version": 0,
"author": {"id": 0,
"name": "string"
},
"comments": "string",
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"attachments": [{"id": 0,
"filename": "string",
"filesize": 0,
"content_type": "string",
"description": "string",
"content_url": "string",
"thumbnail_url": "string",
"author": {"id": 0,
"name": "string"
},
"created_on": "string"
}
]
}
}

Delete wiki page

https://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Deleting-a-wiki-page

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer
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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer
wiki_page_title required	string
version_id required	integer

query Parameters

include

string

Value: "attachments"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"wiki_page": {"title": "string",
"parent": {"title": "string"
},
"text": "string",
"version": 0,
"author": {"id": 0,
"name": "string"
},
"comments": "string",
"created_on": "2019-08-24T14:15:22Z",
"updated_on": "2019-08-24T14:15:22Z",
"attachments": [{"id": 0,
"filename": "string",
"filesize": 0,
"content_type": "string",
"description": "string",
"content_url": "string",
"thumbnail_url": "string",
"author": {"id": 0,
"name": "string"
},
"created_on": "string"
}
]
}
}

Queries

Status: Alpha, Availablity: 1.3

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

List queries

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

200

Content type

application/json

{"queries": [{"id": 0,
"name": "string",
"is_public": true,
"project_id": 0
}
],
"total_count": 0,
"offset": 0,
"limit": 0
}

Attachments

Status: Beta, Availablity: 1.3

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

Show attachment

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
attachment_id required	number

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"attachment": {"id": 0,
"filename": "string",
"filesize": 0,
"content_type": "string",
"description": "string",
"content_url": "string",
"thumbnail_url": "string",
"author": {"id": 0,
"name": "string"
},
"created_on": "string"
}
}

Update attachment

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
attachment_id required	number

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"attachment": {"filename": "string",
"description": "string"
}
}

Delete attachment

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
attachment_id required	number

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Download attachment file

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

attachment_id required	number
filename required	string

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Download thumbnail

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

attachment_id

required

number

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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

query Parameters

filename

string

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Request Body schema: application/octet-stream

string <binary>

Responses

Response samples

201
406

Content type

application/json

{"upload": {"id": 0,
"token": "string"
}
}

Issue Statuses

Status: Alpha, Availablity: 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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"issue_statuses": [{"id": 0,
"name": "string",
"is_closed": true
}
]
}

Trackers

Status: Alpha, Availablity: 1.3

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

List trackers

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"trackers": [{"id": 0,
"name": "string",
"default_status": {"id": 0,
"name": "string"
},
"description": "string",
"enabled_standard_fields": ["string"
]
}
]
}

Enumerations

Status: Alpha, Availablity: 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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"issue_priorities": [{"id": 0,
"name": "string",
"is_default": true,
"active": true,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
]
}
]
}

List time entry activities

https://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#GET-2

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"time_entry_activities": [{"id": 0,
"name": "string",
"is_default": true,
"active": true,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
]
}
]
}

List document categories

https://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#GET-3

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"document_categories": [{"id": 0,
"name": "string",
"is_default": true,
"active": true,
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
]
}
]
}

Issue Categories

Status: Alpha, Availablity: 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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

query Parameters

nometa

integer

Value: 1

header Parameters

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

Responses

Response samples

200

Content type

application/json

{"issue_categories": [{"id": 0,
"project": {"id": 0,
"name": "string"
},
"name": "string",
"assigned_to": {"id": 0,
"name": "string"
}
}
],
"total_count": 0
}

Create issue category

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Request Body schema: application/json

required

object

Responses

Request samples

Payload

Content type

application/json

{"issue_category": {"name": "string",
"assigned_to_id": 0
}
}

Response samples

201
422

Content type

application/json

{"issue_category": {"id": 0,
"project": {"id": 0,
"name": "string"
},
"name": "string",
"assigned_to": {"id": 0,
"name": "string"
}
}
}

Show issue category

https://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#GET-2

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

200

Content type

application/json

{"issue_category": {"id": 0,
"project": {"id": 0,
"name": "string"
},
"name": "string",
"assigned_to": {"id": 0,
"name": "string"
}
}
}

Update issue category

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"issue_category": {"name": "string",
"assigned_to_id": 0
}
}

Response samples

422

Content type

application/json

{"errors": ["string"
]
}

Delete issue category

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
issue_category_id required	integer

query Parameters

reassign_to_id

integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Roles

Status: Alpha, Availablity: 1.4

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

List roles

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"roles": [{"id": 0,
"name": "string"
}
]
}

Show role

https://www.redmine.org/projects/redmine/wiki/Rest_Roles#GET-2

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
role_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"role": {"id": 0,
"name": "string",
"assignable": true,
"issues_visibility": "string",
"time_entries_visibility": "string",
"users_visibility": "string",
"permissions": ["string"
]
}
}

Groups

Status: Alpha, Availablity: 2.1

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

List groups

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"groups": [{"id": 0,
"name": "string",
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
]
}
]
}

Create group

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"group": {"name": "string",
"user_ids": [0
],
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
}
}
}

Response samples

201
422

Content type

application/json

{"group": {"id": 0,
"name": "string",
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
]
}
}

Show group

https://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET-2

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
group_id required	integer

query Parameters

include

Array of strings

Items Enum: "users" "memberships"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"group": {"id": 0,
"name": "string",
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
],
"users": [{"id": 0,
"name": "string"
}
],
"memberships": [{"id": 0,
"project": {"id": 0,
"name": "string"
},
"roles": [{"id": 0,
"name": "string"
}
]
}
]
}
}

Update group

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"group": {"name": "string",
"user_ids": [0
],
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
}
}
}

Delete group

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"user_id": 0
}

Remove user from group

https://www.redmine.org/projects/redmine/wiki/Rest_Groups#DELETE-2

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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, Availablity: 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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"custom_fields": [{"id": 0,
"name": "string",
"customized_type": "issue",
"field_format": "enumeration",
"regexp": "string",
"min_length": 0,
"max_length": 0,
"is_required": true,
"is_filter": true,
"searchable": true,
"multiple": true,
"default_value": "string",
"visible": true,
"trackers": [{"id": 0,
"name": "string"
}
],
"roles": [{"id": 0,
"name": "string",
"assignable": true,
"issues_visibility": "string",
"time_entries_visibility": "string",
"users_visibility": "string",
"permissions": ["string"
]
}
],
"possible_values": [{"value": "string",
"label": "string"
}
]
}
]
}

Search

Status: Alpha, Availablity: 3.3

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

Search

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

query Parameters

limit	integer
offset	integer
nometa	integer Value: 1
q required	string
scope	string Enum: "all" "my_project" "subprojects"
all_words	integer Value: 1
titles_only	integer Value: 1
issues	integer Value: 1
news	integer Value: 1
wiki_pages	integer Value: 1
projects	integer Value: 1
documents	integer Value: 1
changesets	integer Value: 1
messages	integer Value: 1
open_issues	integer Value: 1
attachments	string Enum: "0" "1" "only"

header Parameters

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

Responses

Response samples

200

Content type

application/json

{"results": [{"id": 0,
"title": "string",
"type": "string",
"url": "string",
"description": "string",
"datetime": "2019-08-24T14:15:22Z"
}
],
"total_count": 0,
"offset": 0,
"limit": 0
}

Files

Status: Alpha, Availablity: 3.4

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

List files

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"files": [{"id": 0,
"filename": "string",
"filesize": 0,
"content_type": "string",
"description": "string",
"content_url": "string",
"thumbnail_url": "string",
"author": {"id": 0,
"name": "string"
},
"created_on": "2019-08-24T14:15:22Z",
"version": {"id": 0,
"name": "string"
},
"digest": "string",
"downloads": 0
}
]
}

Create file

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Request Body schema: application/json

required

object

Responses

Request samples

Payload

Content type

application/json

{"file": {"token": "string",
"version_id": 0,
"filename": "string",
"description": "string",
"content_type": "string"
}
}

My Account

Status: Alpha, Availablity: 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:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format

required

string

Enum: "json" "xml"

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Responses

Response samples

200

Content type

application/json

{"user": {"id": 0,
"login": "string",
"admin": true,
"firstname": "string",
"lastname": "string",
"mail": "string",
"created_on": "2019-08-24T14:15:22Z",
"last_login_on": "2019-08-24T14:15:22Z",
"api_key": "string",
"custom_fields": [{"id": 0,
"name": "string",
"value": "string"
}
]
}
}

Update my account

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

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"user": {"login": "string",
"admin": true,
"password": "string",
"firstname": "string",
"lastname": "string",
"mail": "string",
"language": "string",
"auth_source_id": 0,
"mail_notification": "all",
"notified_project_ids": [0
],
"must_change_passwd": true,
"generate_password": true,
"status": 0,
"custom_fields": [{"id": 0,
"value": "string"
}
],
"custom_field_values": {"0": "string"
},
"group_ids": [0
]
},
"pref": {"hide_mail": true,
"time_zone": "string",
"comments_sorting": "asc",
"warn_on_leaving_unsaved": true,
"no_self_notified": true,
"notify_about_high_priority_issues": true,
"textarea_font": "monospace",
"recently_used_projects": 0,
"history_default_tab": "notes",
"toolbar_language_options": "string",
"default_issue_query": 0,
"default_project_query": 0,
"auto_watch_on": "issue_contributed_to"
}
}

Response samples

422

Content type

application/json

{"errors": ["string"
]
}

Journals

Status: Alpha, Availablity: 5.0

https://www.redmine.org/projects/redmine/wiki/Rest_Journals?parent=Rest_api

Update journal

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

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

Payload

Content type

application/json

{"journal": {"notes": "string",
"private_notes": true
}
}

Repositories

Undocumented

Add related issue

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer
repository_id required	integer
revision required	string

header Parameters

X-Redmine-Switch-User

string

Example: jsmith

Request Body schema: application/json

issue_id

required

integer

Responses

Request samples

Payload

Content type

application/json

{"issue_id": 0
}

Remove related issue

Authorizations:

BasicAuthApiKeyAuthApiKeyInQueryAuth

path Parameters

format required	string Enum: "json" "xml"
project_id required	integer
repository_id required	integer
revision required	string
issue_id required	integer

header Parameters

X-Redmine-Switch-User

string

Example: jsmith