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

# Get organization profile



## OpenAPI

````yaml /api-reference/earnie/platform-openapi.json get /v1/organization
openapi: 3.0.3
info:
  title: Earnie Organization Settings API
  description: >-
    Read your organization, and read or change scan configuration, automatic
    scanning, pull request feedback, and local hook settings.
  version: 1.0.0
servers:
  - url: https://{tenant}.earnie.dev
    description: Your Earnie deployment
    variables:
      tenant:
        default: your-company
        description: >-
          Your organization's Earnie address, as shown in your browser when you
          sign in.
security:
  - bearerAuth: []
paths:
  /v1/organization:
    get:
      tags:
        - organization
      summary: Get organization profile
      operationId: GetV1Organization
      responses:
        '200':
          description: Organization profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          description: Not authenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Organization:
      type: object
      required:
        - id
        - name
        - tenant_id
        - primary_contact_email
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        tenant_id:
          type: string
          format: uuid
          description: Immutable tenant identifier (same as org id).
        primary_contact_email:
          type: string
          format: email
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An Earnie API key, sent as `Authorization: Bearer sk_earnie_...`. Create
        one under Settings > API keys. The key's scopes decide which operations
        it may call.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.