> ## Documentation Index
> Fetch the complete documentation index at: https://help.onetsolutions.net/llms.txt
> Use this file to discover all available pages before exploring further.

# [Services] Get service engagement details



## OpenAPI

````yaml https://api.onetsolutions.net/schema get /v1/organizations/{organization_id}/services/{id}
openapi: 3.0.3
info:
  title: OnetSolutions API
  version: v1 (v1)
  description: >

    ## Overview


    The OnetSolutions API provides programmatic access to manage your cloud
    infrastructure, domains, and web hosting services.


    ## Authentication


    All API requests require authentication using one of the following methods:


    - **JWT Token**: Obtain a token via login endpoints and include it in the
    `Authorization: Bearer <token>` header

    - **API Key**: Generate an API key from your account settings and use it as
    `Authorization: Bearer sk-onetsolutions-...`


    ## Rate Limiting


    API requests are rate-limited to ensure fair usage:

    - **Standard**: 1000 requests per minute

    - **Burst**: 100 requests per second


    ## Pagination


    List endpoints return paginated results. Use `page` and `page_size` query
    parameters.


    ## Error Handling


    The API uses standard HTTP status codes:

    - `200` Success

    - `201` Created

    - `400` Bad Request

    - `401` Unauthorized

    - `403` Forbidden

    - `404` Not Found

    - `429` Too Many Requests
servers:
  - url: https://api.onetsolutions.net
    description: Production
security: []
tags:
  - name: Authentication
    description: >-
      Login, passwordless authentication, MFA, OAuth providers, and token
      management.
  - name: Organizations
    description: >-
      Organization management, members, roles, modules, audit logs, and
      notification settings.
  - name: Projects
    description: Project management, team members, and project-scoped resources.
  - name: Compute
    description: >-
      Cloud instances, volumes, snapshots, backups, VPCs, firewalls, SSH keys,
      uptime monitors, and instance tasks.
  - name: Domains
    description: >-
      Domain availability, registration, transfers, DNS zones, DNS records, and
      TLD information.
  - name: Web Hosting
    description: >-
      cPanel-based web hosting, emails, databases, subdomains, FTP accounts,
      addon domains, and SSL certificates.
paths:
  /v1/organizations/{organization_id}/services/{id}:
    get:
      tags:
        - Services
      summary: '[Services] Get service engagement details'
      operationId: get_service_engagement
      parameters:
        - in: path
          name: id
          schema:
            type: string
          description: Service engagement ID
          required: true
        - in: path
          name: organization_id
          schema:
            type: string
          description: Unique identifier of the organization
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceEngagement'
          description: Service engagement details
        '401':
          description: Authentication credentials were not provided or are invalid
        '403':
          description: User does not have permission
        '404':
          description: Service engagement not found
      security:
        - BearerAuth: []
components:
  schemas:
    ServiceEngagement:
      type: object
      description: Serializer for professional-services engagements synced from WHMCS.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        legacy_id:
          type: integer
          readOnly: true
        name:
          type: string
          readOnly: true
          description: Service / product name
        group_name:
          type: string
          readOnly: true
          description: WHMCS product group name
        group_id:
          type: integer
          readOnly: true
          description: WHMCS product group id (discriminator)
        status:
          enum:
            - pending
            - active
            - suspended
            - terminated
            - cancelled
            - completed
          type: string
          description: |-
            * `pending` - Pending
            * `active` - Active
            * `suspended` - Suspended
            * `terminated` - Terminated
            * `cancelled` - Cancelled
            * `completed` - Completed
          x-spec-enum-id: c3bd365189f445c0
          readOnly: true
        billing_cycle:
          enum:
            - hourly
            - monthly
            - quarterly
            - semi_annually
            - annually
            - biennially
            - triennially
          type: string
          description: |-
            * `hourly` - Hourly
            * `monthly` - Monthly
            * `quarterly` - Quarterly
            * `semi_annually` - Semi-Annually
            * `annually` - Annually
            * `biennially` - Biennially
            * `triennially` - Triennially
          x-spec-enum-id: 39fc1593b115d859
          readOnly: true
        amount:
          type: string
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
          readOnly: true
        currency:
          type: string
          readOnly: true
        link:
          type: string
          format: uri
          readOnly: true
          description: Custom field link (e.g. gift detail URL)
        start_date:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          description: Subscription / registration date
        next_due_date:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        end_date:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        is_active:
          type: boolean
          readOnly: true
        created:
          type: string
          format: date-time
          readOnly: true
        modified:
          type: string
          format: date-time
          readOnly: true
      required:
        - amount
        - billing_cycle
        - created
        - currency
        - end_date
        - group_id
        - group_name
        - id
        - is_active
        - legacy_id
        - link
        - modified
        - name
        - next_due_date
        - start_date
        - status
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or API Key
      description: >-
        Use `Authorization: Bearer <token>` header. Token can be a JWT token or
        an API key (format: `sk-onetsolutions-...`).

````