Search decisions

POST /v1/decisions/global-search

Search decisions

cURL

curl --request POST \
  --url https://staging.api.us.aptlydone.com/decision/v1/decisions/global-search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": "105fa115-52d0-4466-baff-740447a60774",
  "ids": null,
  "status": "DRAFT,ARCHIVED",
  "search": "Investmen",
  "section": null,
  "category": null,
  "groupIds": null,
  "delegable": true,
  "delegations": true,
  "authorityTypeIds": null,
  "authorityLimitValueTypes": "Days,Months,Years",
  "authorityLimitValueFilters": [
    {
      "authorityLimitValueType": "Years",
      "minValue": "1",
      "maxValue": "Unlimited"
    }
  ],
  "owner": null,
  "createdStartDate": "2025-03-05T11:49:50.577Z",
  "createdEndDate": "2025-03-05T11:49:50.577Z",
  "updatedStartDate": "2025-03-05T11:49:50.577Z",
  "updatedEndDate": "2025-03-05T11:49:50.577Z",
  "startDate": "2025-03-05T11:49:50.577Z",
  "endDate": "2025-03-05T11:49:50.577Z",
  "selectedTab": "active",
  "sortBy": "name",
  "sortOrder": "asc",
  "select": "DECISION_ID,NAME,DECISION_DISPLAY_ID",
  "issuerType": "ROOT_AUTHORITY",
  "page": 1,
  "limit": 10
}
'

200

{
  "statusCode": 200,
  "timestamp": "2026-01-08T06:33:50.975Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 100,
    "data": [
      {
        "id": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
        "tenantId": "105fa115-52d0-4466-baff-740447a60774",
        "name": "Long-term Investments",
        "description": "The Long-term Investments authority involves approving strategic investments, including equity stakes, acquisitions, and other business ventures.",
        "guidance": "Investment decisions for long-term, strategic investments, such as acquisitions and equity stakes, require a structured process that ensures alignment with corporate strategy, rigorous financial analysis, risk assessment, and strong governance. These investments should enhance the company's competitive positioning, growth potential, and long-term vision. Financial modeling is critical, incorporating valuation methods, cash flow impacts, and sensitivity analysis to forecast returns under different scenarios.",
        "sectionId": "105fa115-52d0-4466-baff-740447a60774",
        "categoryId": "105fa115-52d0-4466-baff-740447a60774",
        "status": "PUBLISHED",
        "createdBy": null,
        "owner": null,
        "createdAt": "2024-12-18T09:50:43.338Z",
        "updatedBy": null,
        "updatedAt": "2024-12-18T09:50:43.338Z",
        "copiedFrom": null,
        "conditionEnabled": false,
        "roleEnabled": false,
        "delegable": true,
        "decisionDisplayId": "14623",
        "delegationPathway": [
          "Matrix",
          "Direct Line",
          "Functional"
        ],
        "link": "/decisions/view/eyJ0ZW5hbnRJZCI6MSwiZGVjaXNpb25JZCI6ImU4YTEzYmQ0LTExYzItNDNkMi1hM2RjLWUxOGQ2ODU1NTU4OCJ9",
        "decisionId": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
        "sectionName": "Financial Authority",
        "categoryName": "Budget Approval",
        "createdByUsername": "John Doe",
        "ownerUsername": "John Doe",
        "updatedByUsername": null,
        "decisionGroups": [
          {
            "id": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
            "denormalizedDecisionId": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
            "groupId": "105fa115-52d0-4466-baff-740447a60774",
            "tenantGroupTypeId": "105fa115-52d0-4466-baff-740447a60774",
            "displayName": "Engineering Team",
            "groupName": "Engineering Team"
          }
        ],
        "decisionAuthorities": [
          {
            "id": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
            "denormalizedDecisionId": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
            "authorityTypeId": "105fa115-52d0-4466-baff-740447a60774",
            "authorityType": "Approval",
            "authorityTypeOrder": 1,
            "authorityTypeIcon": "check-square",
            "authorityLimit": "Primary",
            "authorityLimitValueType": "Currency",
            "authorityLimitOperator": "<",
            "authorityLimitValue": "1000",
            "authorityLimitValueUnit": "$"
          }
        ],
        "decisionDocuments": [
          {
            "id": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
            "denormalizedDecisionId": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
            "documentId": "105fa115-52d0-4466-baff-740447a60774",
            "documentName": "Proxy Comm Delegation of Authority Policy",
            "documentUrl": "https://filesamples.com/samples/document/pdf/sample1.pdf",
            "documentTypeName": "Policy",
            "documentIcon": "file_text_outlined",
            "documentDescription": "Defines the framework for delegating authority across ProxyComm's global operations, outlining roles, responsibilities, and decision-making limits to ensure compliance, accountability, and operational consistency.",
            "documentFileType": "pdf",
            "isPinned": true,
            "documentDisplayId": "10000",
            "documentStatus": "PUBLISHED",
            "documentFileLink": "https://example.com/files/project_document.pdf"
          }
        ],
        "delegations": 0,
        "ownerUserProfileUrl": "http://test.jpg",
        "createdByUserProfileUrl": "http://test.jpg",
        "updatedByUserProfileUrl": "http://test.jpg",
        "permissions": [
          {
            "relationship_key": "<string>",
            "allowed": true
          }
        ],
        "createdByDetails": {},
        "updatedByDetails": {},
        "ownerDetails": {},
        "isRequestActionCompleted": true
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

tenantId · string · required

Tenant ID

Example:

"105fa115-52d0-4466-baff-740447a60774"

ids · string[]

Comma separated Decision IDs

Example:

null

status · object[]

Comma separated Decision Status values

Example:

"DRAFT,ARCHIVED"

search · string

Decision search string

Example:

"Investmen"

section · string[]

Comma separated Section IDs

Example:

null

category · string[]

Comma separated Category IDs

Example:

null

groupIds · string[]

Comma separated Group IDs

Example:

null

delegable · boolean

Delegable filter

Example:

true

delegations · boolean

Delegations filter

Example:

true

authorityTypeIds · string[]

Comma separated Authority Type IDs

Example:

null

authorityLimitValueTypes · string[]

Comma separated Decision Authority Value Types

Example:

"Days,Months,Years"

authorityLimitValueFilters · object[]

Authority Limit Value Filters

Show child attributes

owner · string[]

Comma separated User IDs for Owner filter

Example:

null

createdStartDate · string

Start date time for date range filter on decision created at

Example:

"2025-03-05T11:49:50.577Z"

createdEndDate · string

End date time for date range filter on decision created at

Example:

"2025-03-05T11:49:50.577Z"

updatedStartDate · string

Start date time for date range filter on decision updated at

Example:

"2025-03-05T11:49:50.577Z"

updatedEndDate · string

End date time for date range filter on decision updated at

Example:

"2025-03-05T11:49:50.577Z"

startDate · string

Creation/updation date time for decision

Example:

"2025-03-05T11:49:50.577Z"

endDate · string

Creation/updation date time for decision

Example:

"2025-03-05T11:49:50.577Z"

selectedTab · enum<string>

Selected tab context (not used in the listing API)

Available options: all, active, inactive

Example:

"active"

sortBy · enum<string>

Criteria for sorting Decisions

Available options: name, sectionName, categoryName, status, updatedAt, createdAt, delegationsCount, authorityLimitSortPrecedence, decisionDisplayId, rank

Example:

"name"

sortOrder · enum<string>

Order for sorting Decisions

Available options: asc, desc

Example:

"asc"

select · string[]

Comma separated specific Decision fields needed in response

Example:

"DECISION_ID,NAME,DECISION_DISPLAY_ID"

issuerType · object

Delegation issuer type

Example:

"ROOT_AUTHORITY"

page · number

Page number

Required range: x >= 1

Example:

1

limit · number

Number of items per page

Required range: 1 <= x <= 100

Example:

10

Response

200

application/json

Decisions list retrieved successfully

statusCode · number · required

Example:

200

timestamp · string · required

Example:

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

message · string · required

Example:

"Success"

data · object

Show child attributes