> ## 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. # Create goal > Create a new goal. The goal will be associated with the specified company. ## OpenAPI ````yaml /openapi.json post /api/public/v1/goals 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 environment 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 paths: /api/public/v1/goals: post: tags: - Goals summary: Create goal description: >- Create a new goal. The goal will be associated with the specified company. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateGoalRequest' responses: '201': description: Goal created successfully content: application/json: schema: $ref: '#/components/schemas/GoalSingleResponse' '400': description: Validation error or invalid reference ID content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden - Missing required scope (goals.write) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: CreateGoalRequest: type: object properties: title: type: string minLength: 1 maxLength: 200 description: Goal title (required) description: type: string maxLength: 5000 description: Goal description companyId: type: string format: uuid description: Company ID (required) statusId: type: string format: uuid description: Status ID priorityId: type: string format: uuid description: Priority ID categoryId: type: string format: uuid description: Category ID dueDate: type: string format: date-time description: Due date (ISO 8601) progressPercentage: type: number minimum: 0 maximum: 100 description: Initial progress (0-100) quarter: type: string maxLength: 2 description: Quarter (e.g., Q1) year: type: number minimum: 2000 maximum: 2100 description: Year required: - title - companyId GoalSingleResponse: type: object properties: data: $ref: '#/components/schemas/GoalDetail' required: - data 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 GoalDetail: allOf: - $ref: '#/components/schemas/Goal' - type: object properties: tasks: type: array items: $ref: '#/components/schemas/GoalTask' description: Goal tasks updates: type: array items: $ref: '#/components/schemas/GoalUpdate' description: Goal updates required: - tasks - updates Goal: type: object properties: id: type: string format: uuid description: Goal ID title: type: string description: Goal title description: type: string nullable: true description: Goal description dueDate: type: string nullable: true format: date-time description: Due date (ISO 8601) progressPercentage: type: number minimum: 0 maximum: 100 description: Progress percentage (0-100) quarter: type: string nullable: true description: Quarter (e.g., Q1, Q2) year: type: number nullable: true description: Year company: $ref: '#/components/schemas/GoalCompanyRef' status: $ref: '#/components/schemas/GoalStatusRef' priority: $ref: '#/components/schemas/GoalPriorityRef' category: $ref: '#/components/schemas/GoalCategoryRef' createdAt: type: string format: date-time description: Creation timestamp (ISO 8601) updatedAt: type: string format: date-time description: Last update timestamp (ISO 8601) required: - id - title - description - dueDate - progressPercentage - quarter - year - company - status - priority - category - createdAt - updatedAt GoalTask: type: object properties: id: type: string format: uuid description: Task ID title: type: string description: Task title description: type: string nullable: true description: Task description isCompleted: type: boolean description: Whether the task is completed dueDate: type: string nullable: true format: date-time description: Task due date (ISO 8601) createdAt: type: string format: date-time description: Creation timestamp (ISO 8601) required: - id - title - description - isCompleted - dueDate - createdAt GoalUpdate: type: object properties: id: type: string format: uuid description: Update ID updateText: type: string description: Update text progressPercentage: type: number nullable: true description: Progress percentage at time of update createdAt: type: string format: date-time description: Creation timestamp (ISO 8601) required: - id - updateText - progressPercentage - createdAt GoalCompanyRef: type: object properties: id: type: string format: uuid description: Company ID name: type: string description: Company name required: - id - name GoalStatusRef: type: object nullable: true properties: id: type: string format: uuid description: Status ID name: type: string description: Status name required: - id - name GoalPriorityRef: type: object nullable: true properties: id: type: string format: uuid description: Priority ID name: type: string description: Priority name required: - id - name GoalCategoryRef: type: object nullable: true properties: id: type: string format: uuid description: Category ID name: type: string description: Category name required: - id - name 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. ````