Skip to content
forgit api docs

List tasks on a pull request

GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks

Returns a paginated list of the pull request’s tasks.

This endpoint supports filtering and sorting of the results by the ‘task’ field. See filtering and sorting for more details.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
pull_request_id
required
integer

The id of the pull request.

repo_slug
required
string

This can either be the repository slug or the UUID of the repository, surrounded by curly-braces, for example: {repository UUID}.

workspace
required
string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example: {workspace UUID}.

Query Parameters

Section titled “ Query Parameters ”
q
string

Query string to narrow down the response. See filtering and sorting for details.

sort
string

Field by which the results should be sorted as per filtering and sorting. Defaults to created_on.

pagelen
integer

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

A paginated list of pull request tasks for the given pull request.

Media type application/json
Paginated Tasks

A paginated list of tasks.

object
size

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

integer
page

Page number of the current results. This is an optional element that is not provided in all responses.

integer
>= 1
pagelen

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

integer
>= 1
next

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
previous

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.

string format: uri
values
Array
0 unique items
object
id
integer format: int64
created_on
required
string format: date-time
updated_on
required
string format: date-time
state
required
string
Allowed values: RESOLVED UNRESOLVED
content
required
object
raw

The text as it was typed by a user.

string
markup

The type of markup language the raw content is to be interpreted in.

string
Allowed values: markdown creole plaintext
html

The user’s content rendered as HTML.

string
creator
required
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
pending
boolean
resolved_on

The ISO8601 timestamp for when the task was resolved.

string format: date-time
resolved_by
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
links
object
self
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
html
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
comment
object
type
required
string
id
integer format: int64
created_on
string format: date-time
updated_on
string format: date-time
content
object
raw

The text as it was typed by a user.

string
markup

The type of markup language the raw content is to be interpreted in.

string
Allowed values: markdown creole plaintext
html

The user’s content rendered as HTML.

string
user
object
type
required
string
links
Account Links

Links related to an Account.

object
avatar
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
key
additional properties
any
created_on
string format: date-time
display_name
string
uuid
string
deleted
boolean
parent
object recursive
inline
object
from

The comment’s anchor line in the old version of the file. If the comment is a multi-line comment, this is the ending line number in the old version of the file.

integer
>= 1
to

The comment’s anchor line in the new version of the file. If the comment is a multi-line comment, this is the ending line number in the new version of the file.

integer
>= 1
start_from

The starting line number in the old version of the file, if the comment is a multi-line comment. This is null otherwise.

integer
>= 1
start_to

The starting line number in the new version of the file, if the comment is a multi-line comment. This is null otherwise.

integer
>= 1
path
required

The path of the file this comment is anchored to.

string
links
object
self
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
html
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
code
Link

A link to a resource related to this object.

object
href
string format: uri
name
string
Example 
{
  "values": [
    {
      "state": "RESOLVED",
      "content": {
        "markup": "markdown"
      },
      "comment": {
        "content": {
          "markup": "markdown"
        }
      }
    }
  ]
}

400

Section titled “ 400 ”

If the user provides an invalid filter, sort, or fields query parameter.

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}

403

Section titled “ 403 ”

If the authenticated user does not have access to the pull request.

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}

404

Section titled “ 404 ”

If the pull request does not exist.

Media type application/json
Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object
type
required
string
error
object
message
required
string
detail
string
data

Optional structured data that is endpoint-specific.

object
key
additional properties
any
key
additional properties
any
Example generated 
{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}