> ## 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. # List ticket approvals > Ticket requests held for approval by an approval chain. view=action (default) lists requests waiting on the caller's decision, mine the caller's own requests, all every request the caller may see (MSP staff). Company users only reach their own company's requests. Requires `tickets.read`, read_tickets and the ticket_approval_chains feature. ## OpenAPI ````yaml /openapi.json get /api/public/v1/tickets/approvals 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/tickets/approvals: get: tags: - Tickets summary: List ticket approvals description: >- Ticket requests held for approval by an approval chain. view=action (default) lists requests waiting on the caller's decision, mine the caller's own requests, all every request the caller may see (MSP staff). Company users only reach their own company's requests. Requires `tickets.read`, read_tickets and the ticket_approval_chains feature. parameters: - schema: type: integer minimum: 1 default: 1 description: Page number required: false description: Page number name: page in: query - schema: type: integer minimum: 1 maximum: 100 default: 25 description: Items per page required: false description: Items per page name: limit in: query - schema: type: string enum: - action - mine - all default: action required: false name: view in: query - schema: type: array items: type: string enum: - pending - approved - rejected - cancelled - expired maxItems: 5 description: Filter by status (repeat the key or comma-separate, at most 5) required: false description: Filter by status (repeat the key or comma-separate, at most 5) name: statuses in: query - schema: type: string format: uuid description: Restrict to one company required: false description: Restrict to one company name: companyId in: query responses: '200': description: Approval requests content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/TicketApproval' pagination: $ref: '#/components/schemas/Pagination' required: - data - pagination '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 (tickets.read), the linked user lacks the tickets permission, or no PSA integration is active content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: TicketApproval: type: object properties: id: type: string format: uuid title: type: string status: type: string enum: - pending - approved - rejected - cancelled - expired companyId: type: string format: uuid companyName: type: string nullable: true siteName: type: string nullable: true chain: type: string description: Approval chain (policy) name currentStep: type: integer nullable: true stepCount: type: integer requestedBy: type: string nullable: true requestedAt: type: string decidedAt: type: string nullable: true decidedBy: type: string nullable: true decisionNote: type: string nullable: true overridden: type: boolean ticket: type: object nullable: true additionalProperties: nullable: true description: The ticket it became once approved and sent to the PSA ticketStatus: type: string enum: - none - pending - in_progress - done - failed canDecide: type: boolean description: The caller is an approver of the step that is waiting details: type: array items: type: object properties: label: type: string value: type: string required: - label - value description: What was asked for steps: type: array items: type: object properties: position: type: integer name: type: string nullable: true status: type: string enum: - waiting - active - approved - rejected - expired - skipped requiredApprovals: type: integer dueAt: type: string nullable: true approvers: type: array items: type: object properties: name: type: string nullable: true status: type: string enum: - pending - approved - rejected - skipped decidedAt: type: string nullable: true note: type: string nullable: true required: - name - status - decidedAt - note required: - position - name - status - requiredApprovals - dueAt - approvers history: type: array items: type: object properties: type: type: string enum: - submitted - step_started - no_approvers - approved - rejected - step_approved - override_approved - override_rejected - cancelled - expired - reminded - outcome_done - outcome_failed - outcome_retried - ticket_attached - forwarded step: type: integer nullable: true actor: type: string nullable: true note: type: string nullable: true at: type: string required: - type - step - actor - note - at description: Only on the single-request endpoint required: - id - title - status - companyId - companyName - siteName - chain - currentStep - stepCount - requestedBy - requestedAt - decidedAt - decidedBy - decisionNote - overridden - ticket - ticketStatus - canDecide - details - steps Pagination: type: object properties: page: type: integer minimum: 1 description: Current page number limit: type: integer minimum: 1 maximum: 100 description: Items per page totalCount: type: integer description: Total number of items totalPages: type: integer description: Total number of pages hasNextPage: type: boolean description: Whether there is a next page hasPrevPage: type: boolean description: Whether there is a previous page required: - page - limit - totalCount - totalPages - hasNextPage - hasPrevPage 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 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.