---
title: /getApprovalSessionStatus
slug: getapprovalsessionstatus
createdAt: 2024-01-09T12:30:00.566Z
---

{
  "id": "C4kJrnTh1ZfUjpprvPRQ_",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "http://1.1.1.1/getApprovalSessionStatus",
    "servers": [
      {
        "url": "http://1.1.1.1/getApprovalSessionStatus"
      }
    ],
    "name": "",
    "description": "<ul>\n<li>return - returns an array of approvable transaction ID's</li>\n</ul>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "required",
          "name": "requestId",
          "type": "string",
          "example": "c93b5013e8f9fb5c5b7e0e6223668c1e",
          "description": "<p>Id for request, can be found using getBulletins</p>",
          "default": "c93b5013e8f9fb5c5b7e0e6223668c1e"
        },
        {
          "kind": "optional",
          "name": "machine",
          "type": "array",
          "example": "COLD",
          "description": "Request origination, also can be found in getBulletins",
          "default": "COLD",
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        }
      ],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "body",
          "type": "object",
          "description": "Request data for a machine-related action.",
          "customType": "getApprovalSessionStatusRequest",
          "schema": [
            {
              "name": "FunctionData",
              "kind": "optional",
              "type": "object",
              "example": "",
              "schema": [
                {
                  "name": "Machine",
                  "kind": "optional",
                  "type": "string",
                  "description": "Type of the machine (e.g., COLD).",
                  "example": "COLD",
                  "default": "COLD"
                },
                {
                  "name": "RequestId",
                  "kind": "optional",
                  "type": "string",
                  "description": "Identifier for the request.",
                  "example": "c93b5013e8f9fb5c5b7e0e6223668c1e",
                  "default": "c93b5013e8f9fb5c5b7e0e6223668c1e"
                }
              ]
            },
            {
              "name": "Meta",
              "kind": "optional",
              "type": "object",
              "modelRef": "#/components/schemas/MetaTokengetApprovalSessionStatus",
              "customType": "MetaTokengetApprovalSessionStatus",
              "schema": [
                {
                  "name": "FunctionName",
                  "kind": "optional",
                  "type": "string",
                  "description": "The Function to be called",
                  "example": "getApprovalSessionStatus",
                  "default": "getApprovalSessionStatus"
                },
                {
                  "name": "RandomData",
                  "kind": "optional",
                  "type": "string",
                  "description": "Random Data",
                  "example": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
                  "default": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229"
                },
                {
                  "name": "Destination",
                  "kind": "optional",
                  "type": "string",
                  "description": "Id of the server",
                  "example": "",
                  "default": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea"
                },
                {
                  "name": "Time",
                  "kind": "optional",
                  "type": "string",
                  "description": "UTC Time of execution",
                  "example": "2021-02-07T18:37:46.948Z",
                  "default": "2021-02-07T18:37:46.948Z"
                },
                {
                  "name": "Source",
                  "kind": "optional",
                  "type": "string",
                  "description": "User public key",
                  "example": "",
                  "default": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99"
                },
                {
                  "name": "AccessToken",
                  "kind": "optional",
                  "type": "string",
                  "description": "Token used for authentication purposes",
                  "example": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087",
                  "default": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
                }
              ]
            }
          ],
          "modelRef": "#/components/schemas/getApprovalSessionStatusRequest",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "success",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "customType": "getApprovalSessionStatusResponse",
            "schema": [
              {
                "name": "FunctionData",
                "kind": "optional",
                "type": "object",
                "description": "The data for the function.",
                "example": "{\"ApprovalGroups\":[{\"Approvers\":[{\"Action\":\"Approved\",\"Email\":\"chris@gk8.io\",\"FullName\":\"Cristiano Ronaldo\"},{\"Action\":\"Approved\",\"Email\":\"leo@gk8.io\",\"FullName\":\"Leo Messi\"}],\"Available\":2,\"Name\":\"Approval group 1\",\"Required\":2,\"TotalApproved\":2}],\"ApprovalWorkflowName\":\"barca\",\"ApproverNames\":[\"Cristiano Ronaldo\",\"Leo Messi\"],\"TotalRequired\":2}",
                "schema": [
                  {
                    "name": "ApprovalGroups",
                    "kind": "optional",
                    "type": "array",
                    "description": "A list of approval groups.",
                    "example": "",
                    "itemType": "object",
                    "customType": "object[]",
                    "schema": [
                      {
                        "name": "Approvers",
                        "kind": "optional",
                        "type": "array",
                        "description": "A list of approvers for the approval group.",
                        "example": "",
                        "itemType": "object",
                        "customType": "object[]",
                        "schema": [
                          {
                            "name": "Action",
                            "kind": "optional",
                            "type": "string<Approved>",
                            "description": "The action performed by the approver.",
                            "example": "Approved",
                            "default": "Approved"
                          },
                          {
                            "name": "Email",
                            "kind": "optional",
                            "type": "string<email>",
                            "description": "The email of the approver.",
                            "example": "chris@gk8.io",
                            "default": "chris@gk8.io"
                          },
                          {
                            "name": "FullName",
                            "kind": "optional",
                            "type": "string",
                            "description": "The full name of the approver.",
                            "example": "Cristiano Ronaldo",
                            "default": "Cristiano Ronaldo"
                          }
                        ]
                      },
                      {
                        "name": "Available",
                        "kind": "optional",
                        "type": "integer",
                        "description": "The number of approvers available in the group.",
                        "example": 2,
                        "default": 2
                      },
                      {
                        "name": "Name",
                        "kind": "optional",
                        "type": "string",
                        "description": "The name of the approval group.",
                        "example": "Approval group 1",
                        "default": "Approval group 1"
                      },
                      {
                        "name": "Required",
                        "kind": "optional",
                        "type": "integer",
                        "description": "The number of approvers required for the group.",
                        "example": 2,
                        "default": 2
                      },
                      {
                        "name": "TotalApproved",
                        "kind": "optional",
                        "type": "integer",
                        "description": "The number of approvers who have approved in the group.",
                        "example": 2,
                        "default": 2
                      }
                    ]
                  },
                  {
                    "name": "ApprovalWorkflowName",
                    "kind": "optional",
                    "type": "string",
                    "description": "The name of the approval workflow.",
                    "example": "barca",
                    "default": "barca"
                  },
                  {
                    "name": "ApproverNames",
                    "kind": "optional",
                    "type": "array",
                    "description": "A list of all the approver names.",
                    "example": "[\"Cristiano Ronaldo\"]",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "Cristiano Ronaldo",
                    "itemDefault": "Cristiano Ronaldo",
                    "default": [
                      "Cristiano Ronaldo"
                    ]
                  },
                  {
                    "name": "TotalRequired",
                    "kind": "optional",
                    "type": "integer",
                    "description": "The total number of approvers required for all the groups.",
                    "example": 2,
                    "default": 2
                  }
                ]
              },
              {
                "name": "Meta",
                "kind": "optional",
                "type": "object",
                "modelRef": "#/components/schemas/MetaResponse",
                "customType": "MetaResponse",
                "schema": [
                  {
                    "name": "AccessToken",
                    "kind": "optional",
                    "type": "string",
                    "description": "The new access token generated after this operation",
                    "example": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6",
                    "default": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6"
                  },
                  {
                    "name": "Destination",
                    "kind": "optional",
                    "type": "string",
                    "description": "Id of the server",
                    "example": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622",
                    "default": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622"
                  },
                  {
                    "name": "Source",
                    "kind": "optional",
                    "type": "string",
                    "description": "User public key",
                    "example": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355",
                    "default": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355"
                  },
                  {
                    "name": "Time",
                    "kind": "optional",
                    "type": "string",
                    "description": "UTC Time of execution",
                    "example": "2021-02-14 09:58:52.320",
                    "default": "2021-02-14 09:58:52.320"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/getApprovalSessionStatusResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url 'http://1.1.1.1/getApprovalSessionStatus?requestId=c93b5013e8f9fb5c5b7e0e6223668c1e&machine=COLD' \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data '{\n     \"FunctionData\": {\n     \"Machine\": \"COLD\",\n     \"RequestId\": \"c93b5013e8f9fb5c5b7e0e6223668c1e\"\n     },\n     \"Meta\": {\n     \"FunctionName\": \"getApprovalSessionStatus\",\n     \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n     \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n     \"Time\": \"2021-02-07T18:37:46.948Z\",\n     \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n     \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n     }\n     }'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"FunctionData\": {\n      \"Machine\": \"COLD\",\n      \"RequestId\": \"c93b5013e8f9fb5c5b7e0e6223668c1e\"\n   },\n   \"Meta\": {\n      \"FunctionName\": \"getApprovalSessionStatus\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"http://1.1.1.1/getApprovalSessionStatus?requestId=c93b5013e8f9fb5c5b7e0e6223668c1e&machine=COLD\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"http://1.1.1.1/getApprovalSessionStatus?requestId=c93b5013e8f9fb5c5b7e0e6223668c1e&machine=COLD\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"FunctionData\": {\n      \"Machine\": \"COLD\",\n      \"RequestId\": \"c93b5013e8f9fb5c5b7e0e6223668c1e\"\n   },\n   \"Meta\": {\n      \"FunctionName\": \"getApprovalSessionStatus\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n})\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"http://1.1.1.1/getApprovalSessionStatus?requestId=c93b5013e8f9fb5c5b7e0e6223668c1e&machine=COLD\"\n\npayload = json.dumps({\n   \"FunctionData\": {\n      \"Machine\": \"COLD\",\n      \"RequestId\": \"c93b5013e8f9fb5c5b7e0e6223668c1e\"\n   },\n   \"Meta\": {\n      \"FunctionName\": \"getApprovalSessionStatus\",\n      \"RandomData\": \"288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229\",\n      \"Destination\": \"b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea\",\n      \"Time\": \"2021-02-07T18:37:46.948Z\",\n      \"Source\": \"048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99\",\n      \"AccessToken\": \"51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087\"\n   }\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// success\n{\n  \"FunctionData\": {\n    \"ApprovalGroups\": [\n      {\n        \"Approvers\": [\n          {\n            \"Action\": \"Approved\",\n            \"Email\": \"chris@gk8.io\",\n            \"FullName\": \"Cristiano Ronaldo\"\n          }\n        ],\n        \"Available\": 2,\n        \"Name\": \"Approval group 1\",\n        \"Required\": 2,\n        \"TotalApproved\": 2\n      }\n    ],\n    \"ApprovalWorkflowName\": \"barca\",\n    \"ApproverNames\": [\n      \"Cristiano Ronaldo\"\n    ],\n    \"TotalRequired\": 2\n  },\n  \"Meta\": {\n    \"AccessToken\": \"a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6\",\n    \"Destination\": \"042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622\",\n    \"Source\": \"df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355\",\n    \"Time\": \"2021-02-14 09:58:52.320\"\n  }\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "id": "YiFJLFQpsgS23hygJzcR2",
      "type": "bulleted-list",
      "children": [
        {
          "id": "upl64s5utaVZTaNgifiF-",
          "type": "list-item",
          "children": [
            {
              "id": "441MlBcfqFPaif9h73f2m",
              "type": "list-item-child",
              "children": [
                {
                  "text": "return - returns an array of approvable transaction ID's",
                  "id": "J8tdoYyqvZ_jntzemVQLR"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}