Activity

List a contributor's work one page at a time

Changed on
get/workspaces/{workspaceSlug}/activity/people/{userId}/work

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/activity/people/{userId}/work
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

userIdinteger required

Query parameters

range'30d' | '90d' | '1y' | 'all' | 'custom'

Activity range

fromstring date-time
tostring date-time
teamstring
repostring[]
kindsstring[]

Kinds of activity to list (repeatable); omit for every kind

cursorstring

The previous page's nextCursor; omit for the first page

sizeinteger

Page size from 1 to 100; defaults to 30

Response

One page of contributor work

nextCursorstring

Opaque cursor that fetches the next page when passed back as cursor; absent on the last page

Example response

{
  "content": [
    {
      "actions": [
        {
          "count": 3
        }
      ],
      "work": {
        "number": 42,
        "repository": {
          "labels": [
            {
              "color": "d73a4a"
            }
          ]
        },
        "requestedTeams": [
          {
            "name": "Platform"
          }
        ]
      }
    }
  ]
}

Changes

    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$

    • info

      endpoint added