> ## Documentation Index > Fetch the complete documentation index at: https://docs.msportal.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get company standards > One company's standards deployment: every catalog item with its lifecycle status, deployment options, selected option, target tier (the company's service plan), deployment alignment, vCIO notes and linked planner item. Items with no recorded status are not_started. Company users may only read their own company and never see prices or notes. ## OpenAPI ````yaml /openapi.json get /api/public/v1/standards/companies/{companyId} openapi: 3.0.3 info: title: MSPortal Public API version: 1.0.0 description: >- Public API for MSPortal - provides programmatic access to tenant data. ## Authentication All endpoints require authentication via API key passed as a Bearer token: ``` Authorization: Bearer ``` API keys can be created in the MSPortal dashboard under Settings → Integrations → API Access. **Important:** Do not include cookies in API requests. The public API uses stateless authentication only. ## Scopes API keys are granted specific scopes that determine what operations they can perform. Each endpoint documents its required scope(s). ## Rate Limiting API calls are rate limited per API key. Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests per minute - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: When the rate limit resets (ISO 8601) ## Request ID All responses include an `X-Request-Id` header for debugging and support. You can also pass your own `X-Request-Id` header to correlate requests. contact: name: MSPortal Support email: support@msportal.ai license: name: Proprietary servers: - url: https://app.msportal.ai description: Production (US) - url: https://eu.msportal.ai description: Production (EU) security: - BearerAuth: [] tags: - name: Budgets description: >- Budget management - create, track, and forecast budgets with line items, categories, and products - name: Calendar description: Calendar and meeting management - events, participants, and meeting types - name: Companies description: Company management endpoints - name: Company Users description: Company user management - client portal contacts (read-only, paginated) - name: Compliance description: Compliance check management - runs, assigned checks, and status updates - name: Dashboards description: Dashboard management - external iframe resources and internal dashboards - name: Devices description: Device management - inventory, types, and locations - name: Goals description: Goal management - create, track, and manage goals with tasks and updates - name: NPS Surveys description: >- NPS survey management - Net Promoter Score surveys, responses, and analytics - name: Reports description: >- Report management - create, manage, and schedule reports with templates and types - name: Planner description: >- Planner item management - tasks, roadmap items, and project planning with linked goals, compliance, and projects - name: Surveys description: >- General survey management - multi-question surveys, responses, and statistics - name: Tickets description: Ticket management - view and filter tickets from PSA integrations - name: Training description: >- Training management - courses, enrollments, certificates, and progress tracking - name: Users description: Tenant user management - internal staff and team members (read-only) - name: Automation Rules description: >- Automation rule management - create, configure, and monitor automation rules with triggers, conditions, and actions - name: Analytics description: >- Analytics and reporting - company audit data, training analytics, user activity, and portfolio metrics - name: Client Onboarding description: >- Client onboarding - portals (phases, tasks, contacts, activation), templates, checklist templates, forms and documentation pages - name: Backup description: >- Backup - summaries, protected devices, alerts and SaaS protection (Datto, Axcient, Slide, Kaseya) - name: Microsoft 365 description: Microsoft 365 - licenses, users, domains and Secure Score - name: Security description: >- Security - posture summary, EDR incidents, vulnerabilities, email threats, firewalls, DNS filtering and security awareness - name: Financial description: Financial - quotes, invoices and revenue summaries - name: Integrations description: Integrations - status, sync health, pause and resume (never credentials) - name: Documentation description: >- Documentation - pages, folders and articles synced from Hudu or IT Glue, plus built-in pages - name: Broadcasts description: Broadcasts - emergency broadcasts, recipients and groups - name: Notifications description: Notifications - the linked user's in-app notifications - name: Standards description: >- Standards - technology standards catalog, service plans, applicability, deployment statuses, compliance rollups, white space and costs - name: Customer Success description: >- Customer success - client health scores, trends, benchmarks and Traffic Light Reviews - name: Tasks description: Tasks - the linked user's personal task list - name: Tenant Setup description: Tenant setup - profile, branding and portal settings (never secrets) - name: Roles description: Roles - staff and client roles and their permission grants - name: Ticket Templates description: Ticket templates - reusable ticket definitions - name: Readiness description: Client readiness - account readiness assessments - name: Projects description: >- Projects - PSA projects with health overlays (deliverables, milestones, client actions, weekly updates), phases, tickets, time entries, PSA status/owner/priority write-through, ticket notes, task controls, display settings and the document library paths: /api/public/v1/standards/companies/{companyId}: get: tags: - Standards summary: Get company standards description: >- One company's standards deployment: every catalog item with its lifecycle status, deployment options, selected option, target tier (the company's service plan), deployment alignment, vCIO notes and linked planner item. Items with no recorded status are not_started. Company users may only read their own company and never see prices or notes. parameters: - schema: type: string format: uuid description: Company ID required: true description: Company ID name: companyId in: path responses: '200': description: Company standards content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/CompanyStandardCategory' required: - data '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- Forbidden - missing scope (standards.read) or the linked user lacks the standards permission content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: CompanyStandardCategory: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true icon: type: string nullable: true description: Heroicon component name used by the Standards UI plannerItemTypeId: type: string nullable: true format: uuid description: Planner type applied when standards in this category sync to Planner requireOneOf: type: boolean description: Deploying any one item satisfies the category sortOrder: type: integer items: type: array items: $ref: '#/components/schemas/CompanyStandardItem' required: - id - name - description - icon - plannerItemTypeId - requireOneOf - sortOrder - items ErrorResponse: type: object properties: error: type: string description: Error message requestId: type: string description: Request correlation ID details: nullable: true description: Additional error details code: type: string description: Error code required: - error CompanyStandardItem: type: object properties: id: type: string format: uuid categoryId: type: string format: uuid name: type: string description: type: string nullable: true vendor: type: string nullable: true isRequired: type: boolean defaultPrice: type: number nullable: true description: >- Monthly price charged to each client that has the standard (tenant currency), not the vendor cost. Null for company users. sortOrder: type: integer deploymentOptions: type: array items: $ref: '#/components/schemas/StandardDeploymentOption' status: type: string enum: - not_started - in_progress - deployed - not_applicable - declined notes: type: string nullable: true description: vCIO notes; null for company users plannerItemId: type: string nullable: true format: uuid plannerStatus: type: string nullable: true selectedOptionId: type: string nullable: true format: uuid selectedOption: allOf: - $ref: '#/components/schemas/StandardDeploymentOption' - nullable: true deploymentAlignment: type: string enum: - meets_target - below_target - unmapped_target - unclassified - not_deployed targetTierId: type: string nullable: true format: uuid targetTier: allOf: - $ref: '#/components/schemas/StandardTier' - nullable: true required: - id - categoryId - name - description - vendor - isRequired - defaultPrice - sortOrder - deploymentOptions - status - notes - plannerItemId - plannerStatus - selectedOptionId - selectedOption - deploymentAlignment - targetTierId - targetTier StandardDeploymentOption: type: object properties: id: type: string format: uuid itemId: type: string format: uuid name: type: string description: type: string nullable: true tierId: type: string format: uuid tier: $ref: '#/components/schemas/StandardTier' sortOrder: type: integer required: - id - itemId - name - description - tierId - tier - sortOrder StandardTier: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true color: type: string sortOrder: type: integer required: - id - name - description - color - sortOrder securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.