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

# Get service type

> Get one service type by `serviceTypeId`. An ID that does not match a service type of this carrier returns 400.



## OpenAPI

````yaml /user-docs/api-reference/external-openapi.json post /rms/service_types/get
openapi: 3.1.0
info:
  title: ARMS External API
  version: 1.0.0
  description: >-
    OpenAPI specification generated from external API schemas. Endpoints require
    query parameter carrierId and headers x-arms-api-key and x-arms-assume-user.
  license:
    name: Proprietary
    url: https://cedarai.com
servers:
  - url: https://api-lg.arms.cedarai.com
    description: Production (US)
  - url: https://api-lg.arms.cedarai.se
    description: Production (EU)
security:
  - ApiKeyAuth: []
    AssumeUser: []
paths:
  /rms/service_types/get:
    post:
      summary: Get service type
      description: >-
        Get one service type by `serviceTypeId`. An ID that does not match a
        service type of this carrier returns 400.
      operationId: getServiceType
      parameters:
        - $ref: '#/components/parameters/CarrierId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetServiceTypeInput'
            examples:
              byId:
                summary: By ID
                value:
                  serviceTypeId: 0b6f7d3e-3c55-4a3e-9d0e-6f1f4f0c2a11
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetServiceTypeOutput'
        '400':
          description: Bad Request (for example an unknown `serviceTypeId`)
        '401':
          description: Unauthorized (bad key, carrier not permitted, or missing permission)
        '500':
          description: Internal Server Error
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    CarrierId:
      name: carrierId
      in: query
      required: true
      schema:
        type: integer
      description: Carrier identifier; required for all endpoints
  schemas:
    GetServiceTypeInput:
      type: object
      required:
        - serviceTypeId
      properties:
        carrierId:
          type: integer
          description: >-
            Carrier identifier. Defaults to the `carrierId` query parameter; if
            you send it, use the same value.
        serviceTypeId:
          type: string
          format: uuid
        getDeleted:
          type: boolean
          default: false
          description: >-
            Also find the service type if it was deleted in ARMS. Without it, a
            deleted service type returns 400.
    GetServiceTypeOutput:
      type: object
      properties:
        item:
          $ref: '#/components/schemas/ServiceType'
        contract:
          type: object
          properties:
            effect:
              type: string
              enum:
                - overwriteItem
            resourceType:
              type: string
              enum:
                - ServiceType
    Error:
      type: object
      properties:
        message:
          type: string
    ServiceType:
      type: object
      description: >-
        A service type: what a charge is for. Fields without a value are left
        out.
      properties:
        serviceTypeId:
          type: string
          format: uuid
        carrierId:
          type: integer
        serviceTypeName:
          type: string
        serviceTypeCode:
          type: string
        contextType:
          type: string
          enum:
            - INCIDENTAL
            - CYCLE
            - EXCESS
        serviceTypeGroupId:
          type: string
          format: uuid
        serviceTypeGroupName:
          type: string
        defaultTaxIds:
          type: array
          items:
            type: string
            format: uuid
        createdAt:
          type: string
          format: date-time
        createdById:
          type: string
          format: uuid
        updatedAt:
          type: string
          format: date-time
        updatedById:
          type: string
          format: uuid
        deletedAt:
          type: string
          format: date-time
        deletedById:
          type: string
          format: uuid
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-arms-api-key
      description: Your ARMS API key
    AssumeUser:
      type: apiKey
      in: header
      name: x-arms-assume-user
      description: Email of a user assigned to the appropriate user group

````

## Related topics

- [API Introduction](/user-docs/api-reference/introduction.md)
- [Create service type](/api-reference/create-service-type.md)
- [List service types](/api-reference/list-service-types.md)
- [Update service type](/api-reference/update-service-type.md)
- [QuickBooks Online](/user-docs/accounting-integrations/quickbooks-online.md)