{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Listing the approval data","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"listing-the-approval-data","__idx":0},"children":["Listing the approval data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The APIs below provide the approval data for an approver or a company."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"20%","data-label":"Name"},"children":["Name "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"30%","data-label":"Endpoint"},"children":["Endpoint "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"50%","data-label":"Details"},"children":["Details "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/tripapi#operation/getapprovaluserapprovaldatalist"},"children":["List approval data for an approver"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/approvals/approvers/{userId}/list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve the list of approval data using the approver’s ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userId"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userId"]}," of the approver.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","The request body can contain optional ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/listing_approvals_workflow#filters-for-listing-approval-data"},"children":["filter"]}," parameters."," ","For example, filter by approval type, approval status, etc.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," The list of approval data such as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pnrId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tripId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalStatus"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalVoidDeadline"]},", etc.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," The ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/tripapi#operation/processpnrapproval"},"children":["process PNR approval"]}," endpoint uses"," ","both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pnrId"]}," in the request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/tripapi#operation/getcompanyapprovaldatalist"},"children":["List approval data for a company"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/approvals/companies/{companyId}/list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve the list of approval data using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]}," of the company.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","The request body can contain optional ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/listing_approvals_workflow#filters-for-listing-approval-data"},"children":["filter"]}," parameters. For example, filter by the approver's user ID, approval type, approval status, etc.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," The list of approval data such as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pnrId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tripId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalStatus"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalVoidDeadline"]},", etc.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Other APIs will use:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pnrId"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"filters-for-listing-approval-data","__idx":1},"children":["Filters for listing approval data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both of the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/listing_approvals_workflow"},"children":["list approval data"]}," endpoints allow you to filter the approval data results using specific parameters."," ","The request schema of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalFilters"]}," > ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}," field contains the following filters."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"width":"40%","data-label":"Filters"},"children":["Filters "]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"60%","data-label":"Description"},"children":["Description "]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVER_USER_ID_FILTER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userId"]}," of the approvers.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," This filter is only applicable for the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/tripapi#operation/getcompanyapprovaldatalist"},"children":["list approval data for a company"]}," endpoint."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVAL_TYPE_FILTER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/basic_approval_concepts#types-of-approvals"},"children":["approval types"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVAL_STATUS_FILTER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/basic_approval_concepts#approval-statuses"},"children":["approval statuses"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVAL_DEADLINE_DATE_RANGE_FILTER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/basic_approval_concepts#approval-deadline"},"children":["approval deadlines"]},". For this filter, specify the date range (using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startDate"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endDate"]},") within which the deadline occurs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PRIMARY_TRAVELER_ID_FILTER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by travelers. Specify the list of traveler userIDs for which to retrieve the approval data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PNR_TYPE_FILTER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/basic_trip_concepts#travel-services"},"children":["booking type"]}," (e.g., air, hotel, rail, car, limo, or miscellaneous)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OUT_OF_POLICY_FILTER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by out-of-policy bookings.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","If the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OUT_OF_POLICY_FILTER"]}," is set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", the results will only contain out-of-policy approvals.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","If the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OUT_OF_POLICY_FILTER"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},", the results will contain the approvals that are within the policy."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TRIP_ID_FILTER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by specific ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/spotnana/basic_trip_concepts"},"children":["trip IDs"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," Since the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["approvalFilters"]}," field is an array object,"," ","you can combine two or more filters in the API request."," ","For example, the request can contain both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVER_USER_ID_FILTER"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVAL_TYPE_FILTER"]},"."," ","The response will contain the approval data that matches the approver user IDs and approval type mentioned in the request."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"pagination","__idx":2},"children":["Pagination"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use pagination when listing the approval data."," ","Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paginationRequestParams"]}," > ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," fields to paginate the approval data in the results."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, assume you need to display a list of 75 approval data items per page."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the first API call, set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["75"]},". This will return the first 75 approval data items."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the second API call, set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["75"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["75"]},". This will return the next list of 75 approval data items."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Notes:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," field can contain an integer value between ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]},". This means a maximum of 100 approval data items can be returned in a single API call."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paginationRequestParams"]}," is an optional field. If the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," fields are not specified in the request, a default value of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset: 0"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit: 100"]}," will be set."]}]}]}]},"headings":[{"value":"Listing the approval data","id":"listing-the-approval-data","depth":1},{"value":"Filters for listing approval data","id":"filters-for-listing-approval-data","depth":2},{"value":"Pagination","id":"pagination","depth":2}],"frontmatter":{"toc":{"enable":true,"maxDepth":3},"seo":{"title":"Listing the approval data"}},"lastModified":"2025-04-24T06:01:21.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/spotnana/listing_approvals_workflow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}