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

# Get partner details

> Returns details for a single partner. By default only the minimal "core" fields are returned. Each consumer requests only the sections it needs through the `include` query parameter, which keeps the response small and fast.



## OpenAPI

````yaml openapi/findity-admin-api.json GET /partners/{partnerId}
openapi: 3.1.0
info:
  title: Findity Admin API
  description: Findity Admin API
  version: 1.0.0
servers:
  - url: https://stage-api.findity.com/api/v1/admin
  - url: https://api.findity.com/api/v1/admin
security:
  - bearerAuth: []
paths:
  /partners/{partnerId}:
    get:
      tags:
        - Partner
      summary: Get partner details
      description: >-
        Returns details for a single partner. By default only the minimal "core"
        fields are returned. Each consumer requests only the sections it needs
        through the `include` query parameter, which keeps the response small
        and fast.
      operationId: getPartnerDetails
      parameters:
        - name: partnerId
          in: path
          required: true
          description: Partner external ID
          schema:
            type: string
            example: abc123
        - name: include
          in: query
          required: false
          description: >-
            Comma-separated list of optional sections to add to the response,
            e.g. `?include=invoicing,administrators`.
          explode: false
          style: form
          schema:
            type: array
            items:
              type: string
              enum:
                - settings
                - invoicing
                - identityProvider
                - partnerConfig
                - content
                - administrators
                - paymentSettings
                - memberOrganizations
                - templateOrganizations
          example:
            - invoicing
            - administrators
      responses:
        '200':
          description: Partner details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerDetails'
              example:
                id: abc123
                name: Partner Test
                partnerCode: '123'
                vat: 1234-0000
                clientApplicationId: '987654321'
                invoiceEmailAddress: test@example.com
                licenseGroup: 2
                licensingEnabled: INHERITED
                inheritedLicenseGroup: 2
                inheritedLicensingEnabled: INACTIVE
                partnerType: DIRECT
                settings:
                  showReportOverview: true
                  numberOfReportGroups: 1
                administrators:
                  - id: 1234abcd
                    firstName: Partner
                    lastName: Admin
                    email: admin@example.com
                    supportRole: false
                    invite: false
        '400':
          description: >-
            Bad request - invalid parameters, unknown include value, or not
            allowed to access this partner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400Error'
              example:
                result: error
                code: INVALID_PARAMETER
                description: 'Unknown include value(s): unknownSection'
        '404':
          description: Partner not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404Error'
              example:
                result: error
                code: PARTNER_NOT_FOUND
                description: Partner not found
components:
  schemas:
    PartnerDetails:
      type: object
      description: >
        Partner details response. Only the core fields (id, name, partnerCode,
        vat, clientApplicationId) are always present. Every other field appears
        only when its section is requested via the `include` query parameter.
      properties:
        id:
          type: string
          description: Partner external ID
        name:
          type: string
          description: Partner name
        partnerCode:
          type: string
          description: Partner code
        vat:
          type: string
          nullable: true
          description: VAT number
        clientApplicationId:
          type: string
          description: Client application that owns the partner
        invoiceAddress:
          type: object
          nullable: true
          description: Invoice address (include=invoicing). Free-form address object.
          additionalProperties: true
        invoiceEmailAddress:
          type: string
          nullable: true
          description: Invoice email address (include=invoicing)
        invoiceRefOur:
          type: string
          nullable: true
          description: Our invoice reference (include=invoicing)
        invoiceRefTheir:
          type: string
          nullable: true
          description: Their invoice reference (include=invoicing)
        licenseGroup:
          type: integer
          description: License group identifier (include=invoicing)
        licensingEnabled:
          type: string
          description: >-
            Licensing enabled state (include=invoicing). Accepted values are
            ACTIVE, INACTIVE, INHERITED.
          enum:
            - ACTIVE
            - INACTIVE
            - INHERITED
        inheritedLicenseGroup:
          type: integer
          description: >-
            License group inherited from the client application
            (include=invoicing)
        inheritedLicensingEnabled:
          type: string
          description: >-
            Licensing state inherited from the client application
            (include=invoicing). Accepted values are ACTIVE, INACTIVE,
            INHERITED.
          enum:
            - ACTIVE
            - INACTIVE
            - INHERITED
        dateCreated:
          type: string
          format: date-time
          description: Creation date (include=invoicing)
        identityProviderId:
          type: string
          nullable: true
          description: Identity provider external ID (include=identityProvider)
        identityProviderEnabled:
          type: boolean
          description: Whether the identity provider is enabled (include=identityProvider)
        partnerType:
          type: string
          description: >-
            Partner type (include=partnerConfig). Accepted values are DIRECT,
            INDIRECT.
          enum:
            - DIRECT
            - INDIRECT
        sendEventToExternalSystem:
          type: boolean
          nullable: true
          description: >-
            Whether events are sent to an external system
            (include=partnerConfig)
        settings:
          type: object
          description: >-
            Partner settings map - design, fieldSettings, reports, etc.
            (include=settings). Free-form settings object.
          additionalProperties: true
        content:
          type: array
          description: Partner images - icon, banner, fav icon, menu logo (include=content)
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier of the image resource
              name:
                type: string
                nullable: true
                description: Display name of the image
              contentType:
                type: string
                nullable: true
                description: MIME type of the image (e.g. image/png)
              type:
                type: string
                description: >-
                  Image role. Accepted values are ICON, BANNER, FAV_ICON,
                  MENU_LOGO.
                enum:
                  - ICON
                  - BANNER
                  - FAV_ICON
                  - MENU_LOGO
              url:
                type: string
                nullable: true
                description: URL to retrieve the image
        administrators:
          type: array
          description: Partner administrators (include=administrators)
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier of the administrator
              externalSourceId:
                type: string
                nullable: true
                description: >-
                  External source identifier, if provisioned from an external
                  system
              firstName:
                type: string
                nullable: true
                description: First name of the administrator
              lastName:
                type: string
                nullable: true
                description: Last name of the administrator
              email:
                type: string
                description: Email address of the administrator
              supportRole:
                type: boolean
                description: Whether the administrator has the partner support role
              invite:
                type: boolean
                description: >-
                  Whether the administrator has a pending invitation (not yet
                  activated)
        paymentSettings:
          type: object
          nullable: true
          description: >-
            Customer payment settings for the partner (include=paymentSettings).
            Free-form payment settings object.
          additionalProperties: true
        memberOrganizations:
          type: array
          description: >
            Member organizations (include=memberOrganizations). Non-paginated -
            for paginated/searchable listing use GET
            /v1/admin/partners/{id}/organizations instead.
          items:
            $ref: '#/components/schemas/PartnerMemberOrganization'
        templateOrganizations:
          type: array
          description: Template organizations (include=templateOrganizations)
          items:
            $ref: '#/components/schemas/PartnerTemplateOrganization'
      required:
        - id
        - name
        - partnerCode
        - vat
        - clientApplicationId
    400Error:
      type: object
      properties:
        result:
          type: string
        code:
          type: string
        description:
          type: string
    404Error:
      type: object
      properties:
        result:
          type: string
        code:
          type: string
        description:
          type: string
      example:
        result: error
        code: ORGANIZATION_NOT_FOUND
        description: 'Failed to get organization for id: {orgId}'
    PartnerMemberOrganization:
      type: object
      description: Member organization
      properties:
        id:
          type: string
          description: Organization ID
          example: memberorg123
        name:
          type: string
          description: Organization name
          example: Member Organization
        externalSourceId:
          type: string
          nullable: true
          description: External source identifier
          example: EXT002
        vat:
          type: string
          nullable: true
          description: VAT number
          example: SE123456789001
        dateCreated:
          type: string
          format: date-time
          description: Date when organization was created
        employees:
          type: integer
          nullable: true
          description: Number of employees
          example: 50
        hasOwnLicensePrice:
          type: boolean
          description: Whether organization has its own license price
          example: true
        licensePrice:
          type: number
          nullable: true
          description: License price if hasOwnLicensePrice is true
          example: 25.5
        payedByPartner:
          type: boolean
          nullable: true
          description: Whether organization is paid by partner
          example: false
        label:
          type: string
          nullable: true
          description: Organization label
          example: label
        unverifiedCards:
          type: integer
          nullable: true
          description: Number of unverified cards
          example: 3
        paymentSettings:
          type: object
          nullable: true
          description: Payment settings for the organization
          properties:
            id:
              type: string
              example: payment
            product:
              type: string
              example: product
            priceFixed:
              type: number
              example: 100
        accountingConsultants:
          type: array
          description: List of accounting consultants
          items:
            $ref: '#/components/schemas/AccountingConsultant'
    PartnerTemplateOrganization:
      type: object
      description: Template organization with recipients/consultants information
      properties:
        id:
          type: string
          description: Organization ID
          example: tempid123
        name:
          type: string
          description: Organization name
          example: Template Organization
        externalSourceId:
          type: string
          nullable: true
          description: External source identifier
          example: EXT001
        dateCreated:
          type: string
          format: date-time
          description: Date when organization was created
        accountingSettingsCountryCode:
          type: string
          nullable: true
          description: Country code for accounting settings
          example: SE
        categoryGroups:
          type: array
          description: List of category groups
          items:
            type: string
          example:
            - com.findity.economy.accounting.RepresentationExpenseCategory
        recipients:
          type: array
          description: List of recipients for this template organization
          items:
            $ref: '#/components/schemas/RecipientInfo'
    AccountingConsultant:
      type: object
      description: Accounting consultant information
      properties:
        id:
          type: string
          description: Consultant ID
          example: consultant123
        firstName:
          type: string
          description: First name of consultant
          example: John
        lastName:
          type: string
          description: Last name of consultant
          example: Doe
        email:
          type: string
          description: Email of consultant
          example: john.doe@consultant.com
    RecipientInfo:
      type: object
      description: Recipient/consultant information
      properties:
        id:
          type: string
          description: Recipient ID
          example: recipient123
        integrationPluginName:
          type: string
          description: Integration plugin name
          example: integration plugin name
        recipientName:
          type: string
          description: Display name of recipient
          example: Test Integration
        originalRecipientName:
          type: string
          nullable: true
          description: Original recipient name
          example: Test
        customRecipientName:
          type: string
          nullable: true
          description: Custom recipient name
          example: Custom Test
        email:
          type: string
          nullable: true
          description: Recipient email
          example: integration@test.com
        errorEmail:
          type: string
          nullable: true
          description: Error notification email
          example: errors@test.com
        sortOrder:
          type: integer
          description: Sort order of recipient
          example: 1
        status:
          type: string
          description: Recipient status
          example: NORMAL
        doDebitAccounting:
          type: boolean
          description: Whether recipient does debit accounting
          example: true
        doCreditAccounting:
          type: boolean
          description: Whether recipient does credit accounting
          example: true
        usesAccountingNumbers:
          type: boolean
          description: Whether recipient uses accounting numbers
          example: true
        usesSalaryCodes:
          type: boolean
          description: Whether recipient uses salary codes
          example: false
        requiresApiKey:
          type: boolean
          description: Whether recipient requires API key
          example: true
        hasApiKey:
          type: boolean
          nullable: true
          description: Whether recipient has API key configured
          example: true
        settings:
          type: object
          description: Recipient settings configuration
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````