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

# Get integration



## OpenAPI

````yaml https://api.contracting.kukkingu.software/api/v1/docs.json get /api/v1/integrations/{integrationId}
openapi: 3.1.0
info:
  title: Contracting Backend API
  version: 0.1.0
  description: API documentation for the Contracting backend service.
servers:
  - url: https://api.contracting.kukkingu.software
    description: API server
security:
  - bearerAuth: []
paths:
  /api/v1/integrations/{integrationId}:
    get:
      tags:
        - Integrations
      summary: Get integration
      parameters:
        - schema:
            type: string
            minLength: 1
            description: Unique identifier of the integration.
            example: int_gyl2xn6wplkji4vyvh5k5nqt
          in: path
          name: integrationId
          required: true
          description: Unique identifier of the integration.
        - schema:
            type: string
            example: tnt_pfh0haxfpzowht3oi213cqos
            description: >-
              Specifies the tenant context for the request. All endpoints
              operate within this tenant scope.
          in: header
          name: tenant-id
          required: true
          description: >-
            Specifies the tenant context for the request. All endpoints operate
            within this tenant scope.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                        description: Unique identifier of the integration.
                        example: int_gyl2xn6wplkji4vyvh5k5nqt
                      provider:
                        type: string
                        enum:
                          - google-drive
                          - gmail
                          - jira
                        description: Integration provider.
                      name:
                        type: string
                      status:
                        type: string
                        enum:
                          - PENDING_AUTH
                          - ACTIVE
                          - DISABLED
                          - ERROR
                          - DELETED
                        description: Integration installation status.
                      isAuthorized:
                        type: boolean
                      config:
                        anyOf:
                          - type: object
                            properties:
                              folderId:
                                type: string
                                minLength: 1
                            additionalProperties: false
                            description: Google Drive integration configuration.
                          - type: object
                            properties:
                              senderEmail:
                                type: string
                                format: email
                                pattern: >-
                                  ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
                            additionalProperties: false
                            description: Gmail integration configuration.
                          - type: object
                            properties:
                              siteUrl:
                                type: string
                                format: uri
                              projectKey:
                                type: string
                                maxLength: 255
                                pattern: ^[A-Z][A-Z0-9_]*$
                              projectId:
                                type: string
                                description: Unique identifier of the project.
                                example: prj_8f4d4gk1p9h2x0s7v3n5c1a9
                              syncFrom:
                                type: string
                                format: date
                                pattern: >-
                                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                                description: ISO 8601 formatted date string.
                                example: '2023-10-05'
                            required:
                              - siteUrl
                              - projectKey
                              - projectId
                              - syncFrom
                            additionalProperties: false
                            description: Jira integration configuration.
                      subscriptions:
                        type: array
                        items:
                          type: object
                          properties:
                            eventType:
                              type: string
                              enum:
                                - invoice.created
                                - invoice.saved
                                - invoice.deleted
                              description: Domain event type handled by integrations.
                            clientId:
                              type: string
                              minLength: 1
                              description: Unique identifier of the client.
                              example: clnt_z2b3mo8qa5kzptgsu26q2wmh
                            id:
                              type: string
                              minLength: 1
                              description: Unique identifier of the subscription.
                            scopeKey:
                              type: string
                              minLength: 1
                              description: >-
                                Subscription scope key. Uses 'all' for all
                                clients or a client ID.
                          required:
                            - eventType
                            - id
                            - scopeKey
                          additionalProperties: false
                          description: Integration subscription returned by the API.
                      createdAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        description: ISO 8601 formatted date-time string.
                        example: '2023-10-05T14:48:00.000Z'
                      updatedAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        description: ISO 8601 formatted date-time string.
                        example: '2023-10-05T14:48:00.000Z'
                    required:
                      - id
                      - provider
                      - name
                      - status
                      - isAuthorized
                      - config
                      - subscriptions
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                    description: Integration resource returned by the API.
                required:
                  - data
                additionalProperties: false
                description: Standard success response payload wrapped in a data property.
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    default: Unauthorized
                    description: Machine-readable error code.
                    example: Unauthorized
                    type: string
                  message:
                    default: Unauthorized
                    description: Human-readable error message.
                    example: Unauthorized
                    type: string
                required:
                  - error
                  - message
                additionalProperties: false
                description: Error response for requests without valid authentication.
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    default: Forbidden
                    description: Machine-readable error code.
                    example: Forbidden
                    type: string
                  message:
                    default: Forbidden
                    description: Human-readable error message.
                    example: Forbidden
                    type: string
                required:
                  - error
                  - message
                additionalProperties: false
                description: Error response for requests blocked by authorization rules.
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    default: NotFound
                    description: Machine-readable error code.
                    example: NotFound
                    type: string
                  message:
                    default: Not Found
                    description: Human-readable error message.
                    example: Not Found
                    type: string
                required:
                  - error
                  - message
                additionalProperties: false
                description: Error response when the requested resource does not exist.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````