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

# Read the account's organisation profile

> Readable by **any member** — same posture as the voice, for the same reason: this text lands in every member's system prompt (and the judge/verify prompts). `is_default` is true only when every field is empty, so the profile block renders nothing at all.

A read failure answers 502 and never degrades to an empty profile. Subject: `microstrate.hub.get.coworker-profile`.



## OpenAPI

````yaml /api-reference/endpoint/abbie/openapi.json get /hub/coworker/profile
openapi: 3.1.0
info:
  title: Abbie API (beta)
  version: 1.0.0
  description: >
    **Beta.** This API is in beta: operations and fields may change without a
    deprecation period. Do not depend on undocumented fields. It covers the
    subset of Abbie's API used by the Quiva coworker MCP server: skills, todos,
    memory, profile, corrections, environment and models.


    HTTP surface of hub-service for Abbie/Coworker configuration, agent rapport
    & context, chat-session sharing, and MCP registration.


    ## Transport and response envelope


    Every operation here is a gateway mapping onto a Bellerophon/kraken subject
    of the form `microstrate.hub.<method>.<endpoint-slug>` (see
    `hub-service/service/service.go` and `docs/abbie-gateway-mappings.md`).
    Handlers reply on the mesh with an envelope `{"status_code": <int>, "body":
    <object>}`; the gateway unwraps it, so `status_code` becomes the HTTP status
    and `body` becomes the HTTP response body. **The schemas below describe the
    unwrapped `body`.**


    Errors are always `{"error": "<message>"}` with the matching HTTP status.


    ## Parameter conventions


    The gateway forwards URL parameters to the handler as request headers:


    - `x-param-query-<name>` — a query-string parameter (`?name=value`)

    - `x-param-<name>` — a path parameter


    Every parameter documented as `in: query` or `in: path` below corresponds to
    one of those headers, and the header suffix is named in each parameter's
    description where it is not obvious.


    ## Authentication


    All operations require the caller's bearer token; the account id, user id
    and user public key are always taken from the JWT and never from the URL or
    body. Endpoints that additionally require an account **admin** role are
    marked in their description — a failed role lookup answers **502**, never
    403 and never a pass.


    ## Two path notes


    - `PATCH /hub/agent-session-visibility/{session_id}` — the handler reads the
    path parameter as `x-param-session_id`, matching its sibling `PATCH
    /hub/agent-session/{session_id}`.

    - `GET|POST|PUT /hub/agent/user-context/{id}` — the handler requires the
    **agent id** as `x-param-id`; the frontend calls
    `/hub/agent/user-context/<agentId>`.
servers:
  - url: https://api.quiva.ai
    description: Production API server
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Skills
  - name: Todos
  - name: Memory
  - name: Profile and personality
  - name: Corrections
  - name: Environment
  - name: Models
paths:
  /hub/coworker/profile:
    get:
      tags:
        - Profile and personality
      summary: Read the account's organisation profile
      description: >-
        Readable by **any member** — same posture as the voice, for the same
        reason: this text lands in every member's system prompt (and the
        judge/verify prompts). `is_default` is true only when every field is
        empty, so the profile block renders nothing at all.


        A read failure answers 502 and never degrades to an empty profile.
        Subject: `microstrate.hub.get.coworker-profile`.
      operationId: getCoworkerProfile
      responses:
        '200':
          description: The account's organisation profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoworkerProfileResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '502':
          $ref: '#/components/responses/UpstreamError'
components:
  schemas:
    CoworkerProfileResponse:
      allOf:
        - $ref: '#/components/schemas/CoworkerProfile'
        - type: object
          properties:
            is_default:
              type: boolean
              description: >-
                True when every field is empty, so the profile block renders
                nothing at all
    CoworkerProfile:
      type: object
      description: >-
        The FROZEN wire shape (docs/abbie-org-profile-and-env-request-plan.md
        §B-1a). Every field is optional; absent, `""` and `[]` all mean nothing
        to render — there is no null. Caps are counted in runes and enforced at
        the write; the whole object is additionally capped at 8000 runes summed
        across every field.
      properties:
        legal_name:
          type: string
          maxLength: 500
        trading_names:
          type: array
          items:
            type: string
            maxLength: 200
          maxItems: 10
        what_we_do:
          type: string
          maxLength: 1000
        industry:
          type: string
          maxLength: 200
        regulator:
          type: string
          maxLength: 500
          description: Regulator and/or licence reference
        size:
          type: string
          maxLength: 200
        locations:
          type: string
          maxLength: 500
        financial_year_end:
          type: string
          maxLength: 100
        systems_of_record:
          type: array
          items:
            $ref: '#/components/schemas/CoworkerProfileSystemOfRecord'
          maxItems: 20
        glossary:
          type: array
          items:
            $ref: '#/components/schemas/CoworkerProfileGlossaryEntry'
          maxItems: 40
        working_hours:
          type: string
          maxLength: 300
        timezone:
          type: string
          maxLength: 100
        house_style:
          type: string
          maxLength: 1000
        always:
          type: array
          items:
            type: string
            maxLength: 300
          maxItems: 20
        never:
          type: array
          items:
            type: string
            maxLength: 300
          maxItems: 20
        data_handling:
          type: string
          maxLength: 1000
    Error:
      type: object
      description: The unwrapped error body. The HTTP status carries the code.
      properties:
        error:
          type: string
      required:
        - error
    CoworkerProfileSystemOfRecord:
      type: object
      properties:
        system:
          type: string
          maxLength: 200
          example: NetSuite
        authoritative_for:
          type: string
          maxLength: 300
          example: Supplier and contract data
    CoworkerProfileGlossaryEntry:
      type: object
      properties:
        term:
          type: string
          maxLength: 100
          example: MSA
        meaning:
          type: string
          maxLength: 300
          example: >-
            Master services agreement — the umbrella terms a vendor signs before
            any work order
  responses:
    Unauthorized:
      description: No account (or user) identity in the auth context
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UpstreamError:
      description: >-
        A backend read or write failed — deliberately not degraded to an empty
        or default answer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

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