Over 618,748 projects created

Stream

Event object fields reference

Request Description
GET /v1/activity Returns user activity stream.

Mentions

Mentions object fields reference

Request Description
GET /v1/user/mentions Returns user mentions, all by default.
GET /v1/user/mentions/[id] Returns a mention by id.
PUT /v1/user/mentions/[id]/mark_as_read Mark a mention as read.
  • [id] requested mention id

Users

User object fields reference

Request Description
GET /v1/user Returns currently authenticated user.
GET /v1/users/[id_or_login] Returns user profile.
GET /v1/users/[id_or_login]/picture Returns user profile picture.
GET /v1/spaces/[space_id]/users Returns users for a specified space.
  • [id_or_login] user ID or login
  • [space_id] ID of space

Spaces

Space object fields reference

Request Description
GET /v1/spaces Get list of spaces user is participating to
GET /v1/spaces/[id_or_wiki_name] Show a space by id
POST /v1/spaces Create a space
PUT /v1/spaces/[id_or_wiki_name] Update a space
DELETE /v1/spaces/[id_or_wiki_name] Delete a space
POST /v1/spaces/[id_or_wiki_name]/copy Copy a space from a predefined template
  • [id_or_wiki_name] space ID or wiki_name

User Roles (Space members)

User role object fields reference

Request Description
GET /v1/spaces/[space_id]/user_roles Returns list of user roles (space members)
GET /v1/spaces/[space_id]/user_roles/[id] Show a user role by id
POST /v1/spaces/[space_id]/user_roles Create a user role in space (add a space member)
PUT /v1/spaces/[space_id]/user_roles/[id] Update a user role in space
DELETE /v1/spaces/[space_id]/user_roles/[id] Delete a user role (remove a space member)
  • [id] user role identifier
  • [space_id] space ID or wiki_name

Space tools

space tool object fields reference

Request Description
GET /v1/spaces/[space_id]/space_tools Returns list of space tools in a space
GET /v1/spaces/[space_id]/space_tools/repo Returns a list of repository tools only
GET /v1/spaces/[space_id]/space_tools/[id_or_name] Show a space tool by id or name
POST /v1/spaces/[space_id]/space_tools/[tool_id]/add Add a tool to space
PUT /v1/spaces/[space_id]/space_tools/[id_or_name] Update a space tool, particularly space tool permissions
DELETE /v1/spaces/[space_id]/space_tools/[id_or_name] Remove a space tool from space
  • [id_or_name] space tool identifier or name
  • [space_id] space ID or wiki_name
  • [tool_id] ID of tool

Tickets

Ticket object fields reference

Request Description
GET /v1/spaces/[space_id]/tickets Returns a paginated tickets list filtered by a report. Default report is the space's default report. Pages default to 10 tickets.
GET /v1/spaces/[space_id]/tickets/[number] Returns a ticket by a ticket number.
GET /v1/spaces/[space_id]/tickets/id/[id] Returns a ticket by an id.
POST /v1/spaces/[space_id]/tickets Create a ticket and returns the body and location of newly created ticket.
PUT /v1/spaces/[space_id]/tickets/[number] Update a ticket by number
DELETE /v1/spaces/[space_id]/tickets/[number] Delete a ticket by number
GET /v1/spaces/[space_id]/tickets/[number]/attachments Get the list of attachments associated to ticket.
GET /v1/spaces/[space_id]/tickets/[number]/tags Get the list of tags associated to ticket.
GET /v1/spaces/[space_id]/tickets/custom_reports Get the list of custom reports available for the space
GET /v1/spaces/[space_id]/tickets/my_active Get the list of tickets assigned to current user
GET /v1/spaces/[space_id]/tickets/my_followed Get the list of tickets current user is following
GET /v1/spaces/[space_id]/tickets/milestone/[milestone_id] Get the list of tickets for a milestone
GET /v1/spaces/[space_id]/tickets/no_milestone Get the list of tickets assigned to no milestone
  • [space_id] space ID or wiki_name
  • [number] ticket number
  • [id] ticket ID
  • [milestone_id] ID of the milestone

Note: Be sure to have Tickets Tool attached to your project before using this API.

Ticket statuses

Ticket status object fields reference

Request Description
GET /v1/spaces/[space_id]/tickets/statuses Returns a list of ticket statuses available for space
GET /v1/spaces/[space_id]/tickets/statuses/[id] Returns a ticket status by id.
POST /v1/spaces/[space_id]/tickets/statuses Create a ticket status and returns the body and location of newly created object.
PUT /v1/spaces/[space_id]/tickets/statuses/[id] Update a ticket status by id
DELETE /v1/spaces/[space_id]/tickets/statuses/[id] Delete a ticket status by id
  • [space_id] space ID or wiki_name
  • [id] ticket status ID

Note: Be sure to have Tickets Tool attached to your project before using this API.

Tags

Tag object fields reference

Request Description
GET /v1/spaces/[space_id]/tags Returns a list of tags for space
GET /v1/spaces/[space_id]/tags/active Returns a list of active tags for space
GET /v1/spaces/[space_id]/tags/proposed Returns a list of proposed tags for space
GET /v1/spaces/[space_id]/tags/hidden Returns a list of hidden tags for space
GET /v1/spaces/[space_id]/tags/[id]/tickets Returns a list of tickets for tag by id.
GET /v1/spaces/[space_id]/tags/[id] Returns a tag by id.
POST /v1/spaces/[space_id]/tags Create a tag and returns the body and location of newly tag created.
PUT /v1/spaces/[space_id]/tags/[id] Update a tag by id.
DELETE /v1/spaces/[space_id]/tags/[id] Delete a tag by id.
  • [space_id] space ID or wiki_name
  • [id] tag ID

Tickets custom fields

Tickets custom fields object fields reference

Request Description
GET /v1/spaces/[space_id]/tickets/custom_fields Returns a list of custom fields available for Tickets Tool installed on space.
GET /v1/spaces/[space_id]/tickets/custom_fields/[id] Returns a custom field by id.
POST /v1/spaces/[space_id]/tickets/custom_fields Create a custom field and returns the body and location of newly created object.
PUT /v1/spaces/[space_id]/tickets/custom_fields/[id] Update a custom field by id
DELETE /v1/spaces/[space_id]/tickets/custom_fields/[id] Delete a custom field by id
  • [space_id] space ID or wiki_name
  • [id] ID of custom field

Note: Be sure to have Tickets Tool attached to your project before using this API.

Ticket Associations

Ticket association object fields reference

Request Description
GET /v1/spaces/[space_id]/tickets/[ticket_number]/ticket_associations Returns a list of ticket associations
GET /v1/spaces/[space_id]/tickets/[ticket_number]/ticket_associations/[id] Returns an association by id
POST /v1/spaces/[space_id]/tickets/[ticket_number]/ticket_associations Create an association and get the body and location of newly created association
PUT /v1/spaces/[space_id]/tickets/[ticket_number]/ticket_associations/[id] Update an association by id
DELETE /v1/spaces/[space_id]/tickets/[ticket_number]/ticket_associations/[id] Delete an association by id
  • [space_id] space ID or wiki_name
  • [ticket_number] ticket number
  • [id] association ID

Ticket Comments

Ticket comments object fields reference

Request Description
GET /v1/spaces/[space_id]/tickets/[ticket_number]/ticket_comments Returns a list of ticket comments for ticket
GET /v1/spaces/[space_id]/tickets/[ticket_number]/ticket_comments/[id] Return a ticket comment by id
POST /v1/spaces/[space_id]/tickets/[ticket_number]/ticket_comments Create a ticket comment and returns newly comment body and location in requested format
PUT /v1/spaces/[space_id]/tickets/[ticket_number]/ticket_comments/[id] Update a ticket comment
  • [space_id] space ID or wiki_name
  • [ticket_number] ticket number
  • [id] comment ID

Ticket Components

Ticket components API is deprecated. Please use custom fields.

Ticket components object fields reference

Request Description
GET /v1/spaces/[space_id]/ticket_components Returns a list of components for a space
GET /v1/spaces/[space_id]/ticket_components/[id] Returns a component by id
POST /v1/spaces/[space_id]/ticket_components Create a component and returns the body and location of newly created component
PUT /v1/spaces/[space_id]/ticket_components/[id] Update a component
DELETE /v1/spaces/[space_id]/ticket_components/[id] Delete a component
  • [space_id] space ID or wiki_name
  • [id] component ID

Milestones

Milestone object fields reference

Request Description
GET /v1/spaces/[space_id]/milestones Returns a list of paginated upcoming milestones. Pages are defaulted to 10 milestones.
GET /v1/spaces/[space_id]/milestones/all Returns a list of all milestones paginated. Pages are defaulted to 10 milestones.
GET /v1/spaces/[space_id]/milestones/upcoming Returns a list of paginated upcoming milestones, this query is an alias for milestones query. Pages default to 10 milestones.
GET /v1/spaces/[space_id]/milestones/completed Returns a list of paginated completed milestones. Pages default to 10 milestones.
GET /v1/spaces/[space_id]/milestones/release_notes Returns a list of releases, releases are considered milestones with filed release notes field. Pages default to 10 milestones.
GET /v1/spaces/[space_id]/milestones/[id] Returns a milestone by id
POST /v1/spaces/[space_id]/milestones Create a milestone and returns the newly created resource body in requested format and its location
PUT /v1/spaces/[space_id]/milestones/[id] Update a milestone
DELETE /v1/spaces/[space_id]/milestones/[id] Delete a milestone
  • [space_id] space ID or wiki_name
  • [id] milestone ID

Note: Be sure to have Milestone Tool attached to your project before using this API.

Documents

Document object fields reference

Request Description
GET /v1/spaces/[space_id]/documents Returns a list of documents for a space
GET /v1/spaces/[space_id]/documents/[id] Returns a document by id
POST /v1/spaces/[space_id]/documents Create a document and upload a file to the server, also a ticket, message or milestone association is possible
PUT /v1/spaces/[space_id]/documents/[id] Update a document, upload a new file version or change some document data
DELETE /v1/spaces/[space_id]/documents/[id] Delete a document by id
GET /v1/spaces/[space_id]/documents/[id]/download Download a document by id
  • [space_id] space ID or wiki_name
  • [id] document ID

Note: Be sure to have Files Tool attached to your project before using this API.

StandUp Reports

StandUp report object fields reference

Request Description
GET /v1/spaces/[space_id]/standup_reports Returns a list of standup reports, by default for current day.
GET /v1/spaces/[space_id]/standup_report Returns your standup report, by default for today
POST /v1/spaces/[space_id]/standup_report Create/update a standup report
  • [space_id] space ID or wiki_name
  • [id] StandUp report ID

Note: Be sure to have StandUp tool attached to your project before using this API.

StandUp Away Reports

StandUp report object fields reference

Request Description
GET /v1/spaces/[space_id]/away_standup_reports Returns a list of standup away reports for current month by default.
GET /v1/spaces/[space_id]/away_standup_report Returns your standup away report, for today by default
POST /v1/spaces/[space_id]/away_standup_report Create/update a standup away report
  • [space_id] space ID or wiki_name
  • [id] StandUp away report ID

Note: Be sure to have StandUp tool attached to your project before using this API.

Merge Requests

Merge Request object fields reference

Request Description
GET /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests Returns a list of merge requests in space tool. Pages are defaulted to 10.
POST /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests Creates a new merge request
GET /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[id] Returns a merge request by id
GET /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[merge_request_id]/comments Returns comments that belong to a merge request
PUT /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[id]/merge_and_close Apply and close a merge request.
PUT /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[id]/ignore Ignore a merge request.
GET /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[id]/tickets List of tickets associated with a merge request.
  • [space_id] space ID or wiki_name
  • [space_tool_id] space tool ID or name
  • [id] Merge Request ID
  • [merge_request_id] Merge Request ID

Note: Be sure to have Git/Perforce tool attached to your project before using this API.

Merge Request Versions

Merge Request Version object fields reference

Request Description
GET /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[merge_request_id]/versions Returns a list of merge request versions of a merge request.
GET /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[merge_request_id]/versions/[version] Returns a merge request version by version
POST /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[merge_request_id]/versions Creates a new version for a merge request
  • [space_id] space ID or wiki_name
  • [space_tool_id] space tool ID or name
  • [merge_request_id] merge request ID
  • [version] merge request version version

Note: Be sure to have a tool that supports merge requests attached to your project before using this API.

Merge Request Version Comments

Comment object fields reference

Request Description
GET /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[merge_request_id]/versions/[version]/comments Returns a list of comments of a merge request version
POST /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[merge_request_id]/versions/[version]/comments Creates a comment for a merge request version
  • [space_id] space ID or wiki_name
  • [space_tool_id] space tool ID or name
  • [merge_request_id] merge request ID
  • [version] merge request version version

Note: Be sure to have a tool that supports merge requests attached to your project before using this API.

Merge Request Version Votes

Merge Request Vote object fields reference

Request Description
GET /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[merge_request_id]/versions/[version]/votes Returns a list of votes of a merge request version
POST /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[merge_request_id]/versions/[version]/votes/upvote Upvotes a merge request version
POST /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[merge_request_id]/versions/[version]/votes/downvote Downvotes a merge request version
DELETE /v1/spaces/[space_id]/space_tools/[space_tool_id]/merge_requests/[merge_request_id]/versions/[version]/votes/delete Deletes your vote from a merge request version
  • [space_id] space ID or wiki_name
  • [space_tool_id] space tool ID or name
  • [merge_request_id] merge request ID
  • [version] merge request version

Note: Be sure to have a tool that supports merge requests attached to your project before using this API.

Wiki Pages

Wiki Page object fields reference

Request Description
GET /v1/spaces/[space_id]/wiki_pages Returns a paginated list of wiki pages. Pages are default to 10 wiki pages.
GET /v1/spaces/[space_id]/wiki_pages/[id] Returns a wiki page by id.
POST /v1/spaces/[space_id]/wiki_pages Creates a wiki page.
PUT /v1/spaces/[space_id]/wiki_pages/[id] Updates a wiki page.
DELETE /v1/spaces/[space_id]/wiki_pages/[id]/all Deletes a wiki page and all its child pages.
DELETE /v1/spaces/[space_id]/wiki_pages/[id]/container Move all child pages up one level and delete the wiki page.
  • [space_id] space ID or wiki_name
  • [id] wiki page ID

Note: Be sure to have Wiki tool attached to your project before using this API.

Wiki Page Versions

Wiki Page Version object fields reference

Request Description
GET /v1/spaces/[space_id]/wiki_pages/[wiki_page_id]/versions Returns a paginated list of wiki page versions. Pages are default to 10 wiki page versions.
GET /v1/spaces/[space_id]/wiki_pages/[wiki_page_id]/versions/[id] Returns a wiki page version by id.
  • [space_id] space ID or wiki_name
  • [wiki_page_id] wiki page ID
  • [id] wiki page version ID

Note: Be sure to have Wiki tool attached to your project before using this API.

Webhooks

Webhook object fields reference

Request Description
POST /v1/spaces/[space_id]/webhooks Create a new webhook.
PUT /v1/spaces/[space_id]/webhooks/[webhook_id] Update an existing webhook.
DELETE /v1/spaces/[space_id]/webhooks/[webhook_id] Delete a webhook.
  • [space_id] space ID or wiki_name

Note: Be sure to have Webhook tool attached to your project before using this API.

Tasks

Task object fields reference

Request Description
GET /v1/tasks Returns a paginated list of tasks. Pages are default to 25 tasks.
GET /v1/tasks/[id] Returns a task by id.
POST /v1/tasks Creates a task.
PUT /v1/tasks/[id] Updates a task.
DELETE /v1/tasks/[id] Deletes a task.
  • [id] task ID

Note: Be sure to have Time tool attached to your project before using this API.

User SSH keys

SSHKey object fields reference

Request Description
GET /v1/user/ssh_keys Returns a list of SSH keys.
GET /v1/user/ssh_keys/[id] Returns a SSH key by id.
POST /v1/user/ssh_keys Creates a SSH key.
PUT /v1/user/ssh_keys/[id] Updates a SSH key by id.
DELETE /v1/user/ssh_keys/[id] Deletes a SSH key by id.

Portfolio Stream

Event object fields reference

Request Description
GET /v1/activity Returns user activity stream of a portfolio.

Portfolio Spaces

Space object fields reference

Request Description
GET /v1/spaces Returns a list of spaces.

Portfolio Users

User object fields reference

Request Description
GET /v1/users Returns a list of users.

Portfolio Invitations

User role object fields reference

Request Description
GET /v1/invitations Returns a list of invitations (user roles) which haven't been accepted.
GET /v1/invitations/[id] Returns an invitation (user role) by id.
POST /v1/invitations Invites a user to a portfolio.

Portfolio Groups

Group object fields reference

Request Description
GET /v1/groups Returns a list of groups.
GET /v1/groups/[id] Returns a group by id.
POST /v1/groups Creates a group.
PUT /v1/groups/[id] Updates a group.
DELETE /v1/groups/[id] Deletes a group.

Portfolio Tasks

Task object fields reference

Request Description
GET /v1/tasks Returns a paginated list of tasks.

Portfolio Standup Reports

Standup report object fields reference

Request Description
GET /v1/standup_reports Returns a list of standup reports.
GET /v1/standup_reports/away Returns a list of away reports.
GET /v1/standup_reports/with_needs Returns a list of reports which include needs.

Portfolio Tickets

Ticket object fields reference

Request Description
GET /v1/tickets Returns a paginated list of tickets filtered by ticket report.

Portfolio Ticket Reports

Portfolio Ticket Report object fields reference

Request Description
GET /v1/ticket_reports Returns a list of ticket reports.

Space SSH Keys

Space SSH Key object fields reference

Request Description
GET /v1/spaces/[space_id]/ssh/key Returns a SSH key for the space's SSH tool.
POST v1/spaces/[space_id]/ssh/generate_key Generate a new SSH key for the space's SSH tool. Old key is deleted.

SSH Servers

SSH Server object fields reference

Request Description
GET /v1/spaces/[space_id]/ssh/servers Returns a list of SSH servers.
GET /v1/spaces/[space_id]/ssh/servers/[id] Returns a SSH server by id.
POST /v1/spaces/[space_id]/ssh/servers Creates a new SSH server.
PUT /v1/spaces/[space_id]/ssh/servers/[id] Updates a SSH server.
DELETE /v1/spaces/[space_id]/ssh/servers/[id] Deletes a SSH server.

SSH Actions

SSH Action object fields reference

Request Description
GET /v1/spaces/[space_id]/ssh/actions Returns a list of SSH actions.
GET /v1/spaces/[space_id]/ssh/actions/[id] Returns a SSH action by id.
POST /v1/spaces/[space_id]/ssh/actions Creates a new SSH action.
PUT /v1/spaces/[space_id]/ssh/actions/[id] Updates a SSH action.
DELETE /v1/spaces/[space_id]/ssh/actions/[id] Deletes a SSH action.
GET /v1/spaces/[space_id]/ssh/actions/[id]/run Runs a SSH action.

SSH Action Launches

SSH Action Launch object fields reference

Request Description
GET /v1/spaces/[space_id]/ssh/launches Returns a list of SSH action launches.
GET /v1/spaces/[space_id]/ssh/actions/[id]/launches Returns a list of SSH action launches for an action by id.
GET /v1/spaces/[space_id]/ssh/launches/[id] Returns a SSH launch by id.
GET /v1/spaces/[space_id]/ssh/launches/[id]/output Returns a SSH launch with full output by id.