---
title: "GET /users/current/menu"
method: GET
path: "/users/current/menu"
tags: ["Users"]
---

# GET /users/current/menu

`GET /users/current/menu`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/users/current/menu`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/users/current/menu/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

Indicates that the request succeeded and that the requested information is in the response.

- ServiceChannelServicesMessagingMenuResponse
  - `MainMenu` ServiceChannelServicesMessagingMenuItem[]
    - `Name` string
    - `Url` string
    - `Id` 'None' | 'Track_WOPO' | 'Console' | 'WorkOrders_WorkOrderList' | 'Proposals' | 'RFPsProposals_CreateProposal' | 'RFPsProposals_ViewProposals' | 'RFPsProposals_ViewProcessRFP' | 'RFPsProposals_ViewProcessBulkRFP' | 'RFPsProposals_MySavedProposalReports' | 'RFPsProposals_ViewProcessProposals' | 'RFPsProposals_CreateRFP' | 'Invoices' | 'PaymentManager' | 'ServiceHealth' | 'Home' | 'CreateServiceRequest_ServiceRequestDashboard' | 'CreateServiceRequest_ClassicServiceRequest' | 'WorkOrders_MySavedLiveReports' | 'WorkOrders_OpenCallsOnly' | 'WorkOrders_InProgressCallsOnly' | 'WorkOrders_OpenAndInProgress' | 'WorkOrders_OpenAndInProgressExcludingPartsOnOrder' | 'WorkOrders_OpenAndInProgressExcludingReferredToFM' | 'WorkOrders_OpenAndInProgressExcludingMaintenance' | 'WorkOrders_CompletedCallsOnly' | 'WorkOrders_InvoicedCallsOnly' | 'WorkOrders_AllCalls' | 'WorkOrders_AllCallsLongFormat' | 'WorkOrders_AllCallsUserAssignment' | 'WorkOrders_ArchiveReports_MySavedArchiveReports' | 'WorkOrders_ArchiveReports_CallHistory' | 'WorkOrders_ArchiveReports_AccrualReport' | 'WorkOrders_ArchiveReports_OriginalETAMmissed' | 'WorkOrders_ArchiveReports_ExcessiveCalls' | 'WorkOrders_AuditReports_DataExtract' | 'QuickView' | 'LocationsAndProviderAssignments' | 'PlannedMaintenance_PMServices' | 'PlannedMaintenance_PMLocations' | 'PlannedMaintenance_PMTemplates' | 'SitePlanningReports' | 'AssetsEquipment_Administration' | 'AssetsEquipment_Summary' | 'AssetsEquipment_ManageAssets' | 'AssetsEquipment_ManageAssetTypes' | 'AssetsEquipment_RefrigerantLeakEvents' | 'AssetsEquipment_ImportedAssets' | 'Inventory' | 'CompliancePrivateNetwork' | 'Admin_LocationSettings_LocationNoteHeaders' | 'Admin_LocationSettings_BusinessHours' | 'Admin_WOProperties_Categories' | 'Admin_WOProperties_Priorities' | 'Admin_WOProperties_Statuses' | 'Admin_WOProperties_TradesNTEs' | 'Admin_Accounting_AdditionalApprovalCodes' | 'Admin_Accounting_GLCodes' | 'Admin_Accounting_ImportGLCodeTemplate' | 'Admin_Invoices_General' | 'Admin_Invoices_MLIConfiguration' | 'Admin_Invoices_AutoApproval' | 'Admin_Proposals_MLPConfiguration' | 'Admin_Proposals_AutoApproval' | 'Admin_Proposals_General' | 'Admin_Proposals_ProposalApproveReasons' | 'Admin_Proposals_ProposalAssignReasons' | 'Admin_Permissions_Users' | 'Admin_Permissions_Mobile' | 'Admin_Permissions_Security' | 'Admin_Permissions_ImpersonateUser' | 'Admin_Permissions_APIIntegration' | 'Admin_Permissions_Webhooks' | 'Admin_Permissions_Notifications' | 'Admin_SiteAccessRules' | 'Admin_SitePlanningSetup' | 'Admin_Providers' | 'Admin_Subscribers' | 'Admin_Connector' | 'Admin_UserAccount' | 'Admin_Tools_Surveys' | 'Admin_Tools_CheckLists' | 'Admin_Tools_Announcements' | 'Admin_Tools_RemapProviders' | 'Admin_Tools_UploadTemplates' | 'Admin_Tools_SuppressionListRemoval' | 'Admin_Tools_QuickView' | 'Admin_QualitySurvey_SurveyQuestions' | 'Admin_QualitySurvey_SurveyReport' | 'Admin_Mobile_CIWO' | 'Admin_Mobile_GPS' | 'Admin_UserManagement' | 'Admin_Locations' | 'ServiceProviders' | 'AnalyticsProView' | 'Logout' | 'ReportAnIssue' | 'MobileAccessCode' | 'HelpLinkForSubscribers' | 'HelpLinkForProviders' | 'ProviderSearch' | 'Projects' | 'Admin_Projects_ApprovalConfiguration' | 'Admin_Projects_TypesAndCategories' | 'Admin_Projects_Config' | 'Admin_Spaces_SpacesManager' | 'Admin_Tools_UniversalConnectorSetup' | 'Spaces_Analytics' | 'Spaces_Dashboard' | 'Spaces_Manager' | 'Spaces_Plotter' | 'Spaces_Viewer' | 'Admin_UniversalConnectorConfig' | 'Admin_IssueListSetup' | 'Admin_DashboardSettings' | 'Admin_Proposals_NewMLPConfiguration' | 'Admin_BudgetInsights' | 'PartnerPortal' | 'Admin_PlatformIntelligence_AnomalyOverrides' | 'Admin_PlatformIntelligence_WoSummary' | 'Admin_PlatformIntelligence_WoNotes' | 'FtmBackToSubscriber' | 'Admin_AIActionHub_RuleBuilder' | 'Admin_AIActionHub_ActionLogs' | 'Admin_AIActionHub_Settings' | 'AIActionHub_Tasks' | 'ClientTraining'
    - `Items` ServiceChannelServicesMessagingMenuItem[]
    - `IsAbsoluteUrl` boolean
  - `AccountMenu` ServiceChannelServicesMessagingMenuItem
    - `Name` string
    - `Url` string
    - `Id` 'None' | 'Track_WOPO' | 'Console' | 'WorkOrders_WorkOrderList' | 'Proposals' | 'RFPsProposals_CreateProposal' | 'RFPsProposals_ViewProposals' | 'RFPsProposals_ViewProcessRFP' | 'RFPsProposals_ViewProcessBulkRFP' | 'RFPsProposals_MySavedProposalReports' | 'RFPsProposals_ViewProcessProposals' | 'RFPsProposals_CreateRFP' | 'Invoices' | 'PaymentManager' | 'ServiceHealth' | 'Home' | 'CreateServiceRequest_ServiceRequestDashboard' | 'CreateServiceRequest_ClassicServiceRequest' | 'WorkOrders_MySavedLiveReports' | 'WorkOrders_OpenCallsOnly' | 'WorkOrders_InProgressCallsOnly' | 'WorkOrders_OpenAndInProgress' | 'WorkOrders_OpenAndInProgressExcludingPartsOnOrder' | 'WorkOrders_OpenAndInProgressExcludingReferredToFM' | 'WorkOrders_OpenAndInProgressExcludingMaintenance' | 'WorkOrders_CompletedCallsOnly' | 'WorkOrders_InvoicedCallsOnly' | 'WorkOrders_AllCalls' | 'WorkOrders_AllCallsLongFormat' | 'WorkOrders_AllCallsUserAssignment' | 'WorkOrders_ArchiveReports_MySavedArchiveReports' | 'WorkOrders_ArchiveReports_CallHistory' | 'WorkOrders_ArchiveReports_AccrualReport' | 'WorkOrders_ArchiveReports_OriginalETAMmissed' | 'WorkOrders_ArchiveReports_ExcessiveCalls' | 'WorkOrders_AuditReports_DataExtract' | 'QuickView' | 'LocationsAndProviderAssignments' | 'PlannedMaintenance_PMServices' | 'PlannedMaintenance_PMLocations' | 'PlannedMaintenance_PMTemplates' | 'SitePlanningReports' | 'AssetsEquipment_Administration' | 'AssetsEquipment_Summary' | 'AssetsEquipment_ManageAssets' | 'AssetsEquipment_ManageAssetTypes' | 'AssetsEquipment_RefrigerantLeakEvents' | 'AssetsEquipment_ImportedAssets' | 'Inventory' | 'CompliancePrivateNetwork' | 'Admin_LocationSettings_LocationNoteHeaders' | 'Admin_LocationSettings_BusinessHours' | 'Admin_WOProperties_Categories' | 'Admin_WOProperties_Priorities' | 'Admin_WOProperties_Statuses' | 'Admin_WOProperties_TradesNTEs' | 'Admin_Accounting_AdditionalApprovalCodes' | 'Admin_Accounting_GLCodes' | 'Admin_Accounting_ImportGLCodeTemplate' | 'Admin_Invoices_General' | 'Admin_Invoices_MLIConfiguration' | 'Admin_Invoices_AutoApproval' | 'Admin_Proposals_MLPConfiguration' | 'Admin_Proposals_AutoApproval' | 'Admin_Proposals_General' | 'Admin_Proposals_ProposalApproveReasons' | 'Admin_Proposals_ProposalAssignReasons' | 'Admin_Permissions_Users' | 'Admin_Permissions_Mobile' | 'Admin_Permissions_Security' | 'Admin_Permissions_ImpersonateUser' | 'Admin_Permissions_APIIntegration' | 'Admin_Permissions_Webhooks' | 'Admin_Permissions_Notifications' | 'Admin_SiteAccessRules' | 'Admin_SitePlanningSetup' | 'Admin_Providers' | 'Admin_Subscribers' | 'Admin_Connector' | 'Admin_UserAccount' | 'Admin_Tools_Surveys' | 'Admin_Tools_CheckLists' | 'Admin_Tools_Announcements' | 'Admin_Tools_RemapProviders' | 'Admin_Tools_UploadTemplates' | 'Admin_Tools_SuppressionListRemoval' | 'Admin_Tools_QuickView' | 'Admin_QualitySurvey_SurveyQuestions' | 'Admin_QualitySurvey_SurveyReport' | 'Admin_Mobile_CIWO' | 'Admin_Mobile_GPS' | 'Admin_UserManagement' | 'Admin_Locations' | 'ServiceProviders' | 'AnalyticsProView' | 'Logout' | 'ReportAnIssue' | 'MobileAccessCode' | 'HelpLinkForSubscribers' | 'HelpLinkForProviders' | 'ProviderSearch' | 'Projects' | 'Admin_Projects_ApprovalConfiguration' | 'Admin_Projects_TypesAndCategories' | 'Admin_Projects_Config' | 'Admin_Spaces_SpacesManager' | 'Admin_Tools_UniversalConnectorSetup' | 'Spaces_Analytics' | 'Spaces_Dashboard' | 'Spaces_Manager' | 'Spaces_Plotter' | 'Spaces_Viewer' | 'Admin_UniversalConnectorConfig' | 'Admin_IssueListSetup' | 'Admin_DashboardSettings' | 'Admin_Proposals_NewMLPConfiguration' | 'Admin_BudgetInsights' | 'PartnerPortal' | 'Admin_PlatformIntelligence_AnomalyOverrides' | 'Admin_PlatformIntelligence_WoSummary' | 'Admin_PlatformIntelligence_WoNotes' | 'FtmBackToSubscriber' | 'Admin_AIActionHub_RuleBuilder' | 'Admin_AIActionHub_ActionLogs' | 'Admin_AIActionHub_Settings' | 'AIActionHub_Tasks' | 'ClientTraining'
    - `Items` ServiceChannelServicesMessagingMenuItem[]
    - `IsAbsoluteUrl` boolean
  - `LogoUrl` string
  - `LogoHref` string

## Other responses

- `400`: Bad Request - the request could not be understood or was missing required parameters.
- `401`: Indicates that the requested resource requires authentication. <br/>Error codes: <br/> 504 - API call rejected by security permissions;
- `403`: Indicates that the requested resource not allowed for current user.
- `404`: Indicates that the requested resource does not exist on the server. <br/>Error codes: <br/> 502 - Users not found;

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)