List reports

POST /v1/report/list

List reports

cURL

curl --request POST \
  --url https://staging.api.us.aptlydone.com/report/v1/report/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "limit": 10,
  "tenantId": "89f78ee4-8fba-4356-b067-751f47fd08dc",
  "search": "budget",
  "ownerId": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "reportType": [
    "DECISIONS"
  ],
  "reportStatus": [
    "PUBLISHED"
  ],
  "sortBy": "createdAt",
  "sortOrder": "DESC",
  "startDate": "2024-01-01T00:00:00.000Z",
  "endDate": "2024-12-31T23:59:59.999Z"
}
'

201

{
  "statusCode": 200,
  "timestamp": "2026-01-08T06:33:03.221Z",
  "message": "Success",
  "data": {
    "statusCounts": {
      "published": 31,
      "draft": 4,
      "archived": 4,
      "all": 39
    },
    "reports": {
      "page": 1,
      "limit": 10,
      "total": 100,
      "data": [
        "<array>"
      ]
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

page · number

Page number

Example:

1

limit · number

Page size

Example:

10

tenantId · string<uuid>

Tenant ID (optional, will use auth user active tenant if not provided)

Example:

"89f78ee4-8fba-4356-b067-751f47fd08dc"

search · string

Search keyword

Example:

"budget"

ownerId · string<uuid>[]

Owner ID

reportType · enum<string>[]

Report types

Available options: DECISIONS, DELEGATIONS, ACTIONS, DOCUMENTS, USERS, POSITIONS, GROUPS, MATRICES

reportStatus · enum<string>[]

Report statuses

Available options: PUBLISHED, ARCHIVED, DELETED, DRAFT

sortBy · string

Sort by field

Example:

"createdAt"

sortOrder · object

Sort order

Example:

"DESC"

startDate · string

Start date filter

Example:

"2024-01-01T00:00:00.000Z"

endDate · string

End date filter

Example:

"2024-12-31T23:59:59.999Z"

Response

201 - application/json

Report list retrieved successfully

statusCode · number · required

HTTP Status code

Example:

200

timestamp · string · required

Timestamp of the response

Example:

"2026-01-08T06:33:03.221Z"

message · string · required

Response message

Example:

"Success"

data · object · required

Response data

Show child attributes