> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Pocket Startup Data > NsApiSlow threshold: 5000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-PocketAgent.json post /api/v1/Agents/Pocket/GetPocketStartupData openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - PocketAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/Pocket/GetPocketStartupData: post: tags: - Pocket_Agent summary: Get Pocket Startup Data description: 'NsApiSlow threshold: 5000 ms.' operationId: v1PocketAgent_GetPocketStartupData parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetPocketStartupDataRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetPocketStartupDataRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetPocketStartupDataRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetPocketStartupDataRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetPocketStartupDataRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetPocketStartupDataRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetPocketStartupDataRequest description: Tables, CurrentClientTime required: true responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.PocketStartupData text/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.PocketStartupData application/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.PocketStartupData text/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.PocketStartupData application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.PocketStartupData application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.PocketStartupData security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetPocketStartupDataRequest: description: 'GetPocketStartupData:' type: object properties: Tables: type: array items: type: string CurrentClientTime: format: date-time type: string SuperOffice.CRM.Services.PocketStartupData: description: "The Pocket Service. The service implements pocket specific stuff, like consolidated post-login stuff.\r\n\r\nCarrier object for PocketStartupData.\r\nServices for the PocketStartupData Carrier is available from the Pocket Agent." type: object properties: TableRights: description: >- List of tablerights for logged in user, in the same order as the Tables array parameter type: array items: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string PhoneLocaleTimeZoneData: $ref: '#/components/schemas/SuperOffice.CRM.TimeZoneData' BaseLocaleTimeZoneData: $ref: '#/components/schemas/SuperOffice.CRM.TimeZoneData' OverdueSalesCount: format: int32 description: Number of overdued sales for current user type: integer NotificationsCount: format: int32 description: Number of new invitations type: integer SystemWebPanels: description: Web panels defined in Admin client, set to be shown in Pocket client type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity' PocketPreferences: description: >- All Pocket specific preferences, including WebPanels defined by the user in Pocket type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.Preference' IsPushNotificationEnabled: description: Is push notification configured and enabled in Netserver type: boolean CustomData: description: Custom data for Pocket, in JSON format type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.TimeZoneData: type: object properties: TZLocationID: format: int32 description: Timezone location ID - primary key. type: integer Name: description: >- Name associated with the location: Country name + region name, Norway, United States - Alaska type: string TZLocationCode: description: "Code associated with location: UTC, AR-NQ, AU-QLD, PF2A\r\nNot the an ISO country code. Unique." type: string TZLocationCities: description: 'Cities associated with location: Oslo, London, Rio de Janeiro' type: string IsoNumber: format: int32 description: 'Country ISO code associated with location: 578' type: integer TimeZoneSTDRules: description: Dictionary of standard rules type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.TimeZoneRule' TimeZoneDSTRules: description: Dictionary of Daylight saving time rules type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.TimeZoneRule' SuperOffice.CRM.Services.WebPanelEntity: description: "The web panel entity contains information on a web panel\r\n\r\nCarrier object for WebPanelEntity.\r\nServices for the WebPanelEntity Carrier is available from the List Agent." type: object properties: WebPanelId: format: int32 description: The identity of the web panel type: integer Name: description: The name of the web panel type: string Tooltip: description: The tooltip of the web panel type: string Deleted: description: True if the web panel is marked as deleted type: boolean Rank: format: int32 description: The rank of the web panel type: integer UrlEncoding: description: The encoding of the URL enum: - Unknown - None - ANSI - Unicode type: string VisibleIn: description: The webpanel is visible in enum: - Invisible - ToolboxMenu - NavigatorButton - ViewMenu - SelectionTaskCard - ContactCard - ContactArchive - ProjectCard - ProjectArchive - SaleCard - PersonCard - ActivityDialog - DocumentDialog - BrowserPanel - ContSelectionTask - AppntSelectionTask - SaleSelectionTask - DocSelectionTask - ProjSelectionTask - CompanyMinicard - ProjectMinicard - DiaryMinicard - SelectionMinicard - ButtonPanelTask - AppointmentDialogTask - SaleDialogTask - DocumentDialogTask - PersonDialogTask - SaleMinicard - SaleArchive - AppntSelectionShadowTask - SaleSelectionShadowTask - DocSelectionShadowTask - ProjSelectionShadowTask - DiaryArchive - SelectionContactArchive - SelectionProjectArchive - SelectionSaleArchive - SelectionAppointmentArchive - SelectionDocumentArchive - ContSelectionCustomTask - AppntSelectionCustomTask - SaleSelectionCustomTask - DocSelectionCustomTask - ProjSelectionCustomTask - CustomArchiveMiniCard - SelectionCard - ReportMinicard - QuoteDialog - QuoteDialogTask - QuoteDialogArchive - QuoteLineDialogTask - QuoteLineDialog - QuoteLineSelectionMainTask - QuoteLineSelectionShadowTask - SelectionQuoteLineArchive - QuoteLineSelectionCustomTask - FindSystem - MailingSelectionTask - ContactSelectionMailingsTask - AppointmentSelectionMailingsTask - SaleSelectionMailingsTask - DocumentSelectionMailingsTask - ProjectSelectionMailingsTask - QuoteLineSelectionMailingsTask - TopPanelNewMenu - Dashboard - PersonArchive - PersonMinicard - CompanyCardTask - ProjectCardTask - TicketCard - TicketMinicard - CustomObjectCard - CustomObjectArchive type: string OnCentral: description: Is the webpanel visible when user is on central database type: boolean OnSatellite: description: Is the webpanel visible when user is on a satellite type: boolean OnTravel: description: Is the webpanel visible when user is on travel type: boolean OnSalesMarketingWeb: description: Is the webpanel visible when user is on web client type: boolean OnSalesMarketingPocket: description: Is the webpanel visible when user is on pocket client type: boolean ShowInMenuBar: description: Does the webpanel have a menu bar type: boolean ShowInToolBar: description: Does the webpanel have a toolbar type: boolean ShowInAddressBar: description: Does the webpanel have an address bar type: boolean ShowInStatusBar: description: Does the webpanel have a status bar type: boolean WindowName: description: The window which the URL address is to open in (webpanel only) type: string Url: description: The url type: string ProgId: description: >- String key that can be used to uniquely retrieve the panel; particularly useful for partners and others who do not wish to store database ID's type: string Icon: format: int32 description: The icon of the webpanel type: integer AlwaysReloadOnShow: description: >- If set to true, the content will reload every time the panel is shown type: boolean NeverReloadOnCurrentChange: description: >- If set to true, the content will not reload on current changes, only applies to sidepanels type: boolean CustomObjectEntity: description: The name of the custom object when VisibleIn is set to custom object type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Preference: description: "One preference item, which contains a specification (section/key), the raw string value, and the level at which this value was found.\r\n\r\nCarrier object for Preference.\r\nServices for the Preference Carrier is available from the Preference Agent." type: object properties: Level: description: >- Preference level, using the standard enumerated type. Undefined is returned for preferences that do not have a current setting. enum: - Undefined - HardDefault - SystemWide - Database - Group - Individual - PC type: string RawValue: description: Preference value type: string Specification: $ref: '#/components/schemas/SuperOffice.CRM.Services.PreferenceSpec' DisplayValue: description: >- Display value, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter. type: string DisplayTooltip: description: >- Display tooltip, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter. type: string DisplayType: description: Display type, populated when asked for. enum: - Unknown - Number - Text - Bool - ListOfValues - ListTableRef - TimeList - ContactID - PersonID - ProjectID - SelectionID - PosSize - TimeZone - Time - Password - MultiLineText type: string TabOrder: $ref: '#/components/schemas/SuperOffice.CRM.Services.TabOrder' TargetId: format: int32 description: >- The id of the target row. The table it points at is specified by the preference type. type: integer PrefDescId: format: int32 description: The id of the prefdesc this preference is connected to type: integer TableName: description: >- For DisplayType=PrefDescValueType.ListTableRef, TableName will contain the name of the table which the value reference to. type: string UserPreferenceId: format: int32 description: The id of the user preference type: integer TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.TimeZoneRule: type: object properties: StartDay: format: int32 type: integer StartMonth: format: int32 type: integer EndDay: format: int32 type: integer EndMonth: format: int32 type: integer TZOffset: format: int32 type: integer StartRulePattern: type: string EndRulePattern: type: string SuperOffice.CRM.Services.PreferenceSpec: description: "Preference specification, consisting of the section name and key name\r\n\r\nCarrier object for PreferenceSpec.\r\nServices for the PreferenceSpec Carrier is available from the Preference Agent." type: object properties: Section: description: Preference section name type: string Key: description: Preference key name type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.TabOrder: description: "Carrier object for TabOrder.\r\nServices for the TabOrder Carrier is available from the Preference Agent." type: object properties: TabOrderId: format: int32 description: Primary key type: integer TabName: description: Name of tab control type: string Order: description: The actual tab order type: string AssociateId: format: int32 description: Associate who owns this tab order type: integer TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [SuperOffice.WebApi.Data.Pocket GetPocketStartupDataRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Pocket_GetPocketStartupDataRequest.md) - [NSPocketAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSPocketAgent.md) - [NSPocketStartupData](/en/automation/crmscript/reference/CRMScript.NetServer.NSPocketStartupData.md) - [SuperOffice.WebApi.Data.PocketStartupData](/en/api/reference/webapi/SuperOffice.WebApi.Data.PocketStartupData.md) - [SuperOffice.WebApi.Data.Quote GetConnectionStartupErrorsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Quote_GetConnectionStartupErrorsRequest.md) - [SuperOffice.WebApi.Data.Quote GetConnectionStartupResponseRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Quote_GetConnectionStartupResponseRequest.md)