Skip to main content
POST
/
v1
/
matrix
/
global-search
List matrices
curl --request POST \
  --url https://staging.api.us.aptlydone.com/matrix/v1/matrix/global-search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "page": 1,
  "limit": 10,
  "tenantId": "08b3b013-79ea-4994-961f-9e7928d39618",
  "search": "Authority Wisdom",
  "startDate": "2025-03-05T11:49:50.577Z",
  "endDate": "2025-03-05T11:49:50.577Z",
  "matrixStatusName": "Active",
  "sortBy": "matrixName",
  "sortOrder": "asc",
  "groupIds": null,
  "matrixSharingType": "SHARED",
  "ownerIds": null,
  "decisionsCount": {
    "minValue": "1",
    "maxValue": "Unlimited"
  },
  "delegationsCount": {
    "minValue": "1",
    "maxValue": "Unlimited"
  },
  "select": "id,matrixName,matrixDescription,matrixStatus"
}'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:12.369Z",
  "message": "Success",
  "data": {
    "page": 1,
    "limit": 10,
    "total": 10,
    "data": [
      {
        "id": "d1019e1d-b9cd-4a72-873b-b864a49fea82",
        "matrixId": "10001",
        "matrixName": "Beahan Group Approval Matrix",
        "matrixDescription": "Audeo campana speculum thymum accusantium tenus.",
        "link": "/matrix/view/base64",
        "roleMatrix": true,
        "authorityMatrix": true,
        "tenantId": "b72c2ad3-3676-479c-b6e6-7f754c488663",
        "ownerId": "05747826-2033-450d-9947-a66ff1766e26",
        "matrixSections": [
          {
            "sectionId": "2ff23fd9-6dea-4876-8da2-3a43bc58f71a",
            "name": "Finance"
          }
        ],
        "matrixCategories": [
          {
            "categoryId": "891c8bdd-a089-4f44-ab22-00a5b2911f72",
            "name": "Approvals"
          }
        ],
        "decisionCount": 5,
        "delegationCount": 2,
        "suspendedDelegationsCount": 2,
        "pendingDelegationsCount": 2,
        "copiedFromMatrix": "4b9ea214-ddd7-4b5e-b161-d8b903656bb3",
        "ownerDetails": {
          "id": "c127e8f7-13da-4a50-859f-8564ed38294b",
          "email": "[email protected]",
          "name": "Roy Powlowski I",
          "firstName": "Dorthy",
          "lastName": "Kertzmann",
          "mobilePhone": "635-388-2189 x775",
          "isActive": true,
          "profileImageUrl": "https://avatars.githubusercontent.com/u/66649439",
          "positions": [
            "<any>"
          ]
        },
        "createdOn": "2025-06-24T04:16:48.882Z",
        "updatedOn": "2025-06-24T00:37:13.311Z",
        "currentTab": "Sharing",
        "isFavorite": true,
        "matrixStatus": {
          "id": "4a548542-f1c7-444e-9064-dda8ab4168ba",
          "statusName": "Active",
          "isActive": true
        },
        "matrixSharing": {
          "id": "29a1b66a-16ab-4e84-b802-46ff07fffbd9",
          "type": "SHARED",
          "sharingOption": "USERS_GROUPS",
          "link": true,
          "viewerAdjustableFilters": true,
          "externalSharing": false,
          "users": [
            {
              "id": "32fdd6f8-6aaf-4bc6-af89-ea50865b91bf",
              "userId": "baf5a26a-26ec-475d-a18e-1817a47ca7cc",
              "userDetails": {
                "id": "c127e8f7-13da-4a50-859f-8564ed38294b",
                "email": "[email protected]",
                "name": "Roy Powlowski I",
                "firstName": "Dorthy",
                "lastName": "Kertzmann",
                "mobilePhone": "635-388-2189 x775",
                "isActive": true,
                "profileImageUrl": "https://avatars.githubusercontent.com/u/66649439",
                "positions": [
                  "<any>"
                ]
              }
            }
          ],
          "groups": [
            {
              "id": "c07b3db7-621e-4d25-bad4-3c6ddc06a4da",
              "groupId": "cbbb3152-1d16-43ec-a5ad-eb604fbf3f3e",
              "groupDetails": {
                "id": "66bc5e67-4a01-4f6c-99d9-75d259ebf088",
                "groupName": "Finance Department",
                "tenantId": "251baf0f-d015-4fd3-ba86-28eb729f342c",
                "groupTypeName": "Department",
                "groupTypeId": "43754328-308d-43a7-9097-7ebc51474c7a",
                "status": "ACTIVE",
                "parentGroupIds": [
                  "b8be636a-849a-4a09-bc28-e624104e980d"
                ],
                "isSynced": false
              }
            }
          ]
        },
        "matrixAuthorityRoles": [
          {
            "id": "9f787fb3-897b-4863-86ca-dc494d49a42e",
            "authorityRoleId": "320f5be2-3998-4231-8417-ebd9d29f7eeb",
            "isEnabled": true
          }
        ],
        "matrixGroups": [
          {
            "id": "d087ff44-f5f6-461c-9add-5305e4f60920",
            "tenantGroupsMappingId": "f9f7efc8-4dca-4914-910a-22915228ce94",
            "groupDetails": {
              "id": "66bc5e67-4a01-4f6c-99d9-75d259ebf088",
              "groupName": "Finance Department",
              "tenantId": "251baf0f-d015-4fd3-ba86-28eb729f342c",
              "groupTypeName": "Department",
              "groupTypeId": "43754328-308d-43a7-9097-7ebc51474c7a",
              "status": "ACTIVE",
              "parentGroupIds": [
                "b8be636a-849a-4a09-bc28-e624104e980d"
              ],
              "isSynced": false
            }
          }
        ],
        "matrixPositions": [
          {
            "id": "7aa8d2ad-82e2-4dd2-95f5-aca238f8ba5e",
            "positionId": "c864683d-a440-40df-8561-c310ea3c4e17",
            "positionDetails": {
              "id": "e5a73191-c107-47e2-a883-cad51e5abd03",
              "tenantId": "e9ffaaae-07b0-4960-a32d-80e1f600bd0f",
              "positionName": "System Administrator",
              "isScimProvisioned": false,
              "status": "ACTIVE",
              "groupIds": [
                "b52424e3-a334-4171-818c-d863ac406de4",
                "a6d41d50-fb63-4e8b-b8a4-241d2534ec25"
              ]
            }
          }
        ],
        "matrixUsers": [
          {
            "id": "d5316153-7c42-4a38-9136-4b41c656343f",
            "userId": "95e4fa48-9fb5-4fa2-b193-df89187be95d",
            "userDetails": {
              "id": "c127e8f7-13da-4a50-859f-8564ed38294b",
              "email": "[email protected]",
              "name": "Roy Powlowski I",
              "firstName": "Dorthy",
              "lastName": "Kertzmann",
              "mobilePhone": "635-388-2189 x775",
              "isActive": true,
              "profileImageUrl": "https://avatars.githubusercontent.com/u/66649439",
              "positions": [
                "<any>"
              ]
            }
          }
        ],
        "matrixDecisions": [
          {
            "id": "88ae98b4-62fb-42d5-99cd-6c533840b562",
            "decisionId": "d5122be0-9c67-4172-942d-d6b53680f519",
            "isDisabled": false,
            "disabledOn": null
          }
        ],
        "matrixDelegation": {
          "authorityTypeIds": [
            "f0b63af0-99d8-47bb-a567-1ef3cf8cc338",
            "f3ca4dc6-c85c-4512-abff-d7fecdccff86"
          ],
          "delegationRole": true,
          "roleIds": [
            "b2692430-9e07-48bb-bfba-8b736b029192",
            "6830fc5c-3d3b-43b8-b2c0-49f02c926c8c"
          ],
          "issuanceStatusNames": [
            "Accepted",
            "Pending"
          ],
          "primaryLimitTypes": {
            "Value (Currency)": {
              "min": 1,
              "max": 2
            },
            "Time (Months)": {
              "min": 1,
              "max": 2
            },
            "Time (Years)": {
              "min": 1,
              "max": 2
            },
            "Authority": true
          },
          "delegationDataDetails": true,
          "delegationDataGroups": true,
          "delegationDataDocuments": true,
          "delegationDataConditions": true,
          "delegationDataAuthorities": true,
          "delegationDataRoles": true
        },
        "matrixAuthorityFormatting": {
          "valueAbbrevations": "Actual Values",
          "valueRounding": "0 decimals",
          "timeUnit": "Actual Values",
          "timeRounding": "0 decimals",
          "delegationIdentification": "Position Username",
          "displayCurrencyCode": "USD"
        },
        "permissions": [
          {
            "allowed": true,
            "relationship_key": "<string>"
          }
        ],
        "isUserSavedPersonalView": 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:

"08b3b013-79ea-4994-961f-9e7928d39618"

​
page
number

Page number

Required range: x >= 1
Example:

1

​
limit
number

Number of items per page

Required range: 1 <= x <= 100
Example:

10

​
search
string

Matrices search string

Example:

"Authority Wisdom"

​
startDate
string

Creation/updation date time for matrices

Example:

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

​
endDate
string

Creation/updation date time for matrices

Example:

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

​
matrixStatusName
string[]

Comma separated Matrix Status values for matrices list

Example:

"Active"

​
sortBy
string

Criteria for sorting Decisions

Example:

"matrixName"

​
sortOrder
enum<string>

Order for sorting Decisions

Available options:
asc,
desc
Example:

"asc"

​
groupIds
string[]

Comma separated Group IDs

Example:

null

​
matrixSharingType
object[]

Comma separated Matrix Sharing Type values

Example:

"SHARED"

​
ownerIds
string[]

Comma separated Owner User IDs

Example:

null

​
decisionsCount
object

Decisions count filter

​
delegationsCount
object

Delegations count filter

​
select
enum<string>[]

Comma separated fields to select in response

Example:

"id,matrixName,matrixDescription,matrixStatus"

Response

Matrix list retrieved successfully

​
statusCode
number
required
Example:

200

​
timestamp
string
required
Example:

"2025-06-24T08:51:12.369Z"

​
message
string
required
Example:

"Success"

​
data
object