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

# Get person

> Draft contract for retrieving one person and their authorized employments.

**Coming soon — unavailable in sandbox and production.** The code sample uses the current Partner API host for illustration; the final hostname and contract are undecided. Do not send requests to this route.

Each `employments` entry would be a complete Employee object in a credential-authorized company, including top-level `participation` and `coverage`. Person-level demographics or statuses would not be selected; those values stay within each employment. Person `updatedAt` would not track nested employment changes.

The proposal calls for HTTP `404` when the Person does not exist or has no employment in a credential-authorized company. Response-size limits for complete employment arrays remain undecided.


## OpenAPI

````yaml GET /v1/persons/{personId}
openapi: 3.1.0
info:
  title: Rima Partner API proposed endpoints
  version: draft
  description: Documentation preview only. These operations are not implemented.
servers:
  - url: https://partner-api.tryrima.com
    description: Rima (route not available)
security: []
paths:
  /v1/persons/{personId}:
    get:
      summary: Get person
      description: Proposed endpoint. Not available in any environment.
      parameters:
        - name: personId
          in: path
          required: true
          description: Person UUID.
          schema:
            type: string
            format: uuid
        - name: externalIdSystems
          in: query
          required: false
          description: Repeat for each system; selects which external IDs are returned.
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Proposed person record.
          content:
            application/json:
              schema:
                type: object
                properties:
                  asOf:
                    type: string
                    format: date-time
                  person:
                    $ref: '#/components/schemas/Person'
                required:
                  - asOf
                  - person
              examples:
                example:
                  value:
                    asOf: '2026-10-13T15:00:00Z'
                    person:
                      id: 44444444-4444-4444-8444-444444444444
                      employments:
                        - id: 11111111-1111-4111-8111-111111111111
                          companyId: company_example
                          personId: 44444444-4444-4444-8444-444444444444
                          externalIds:
                            - system: payroll_system
                              system_id: PAYROLL-001
                          demographics:
                            firstName: Avery
                            lastName: Morgan
                            dateOfBirth: '1990-04-12'
                            gender: null
                          contact:
                            email: avery.morgan@example.com
                            phone: '+13125550100'
                            address:
                              line1: 100 Example Street
                              line2: null
                              city: Chicago
                              state: IL
                              postalCode: '60601'
                          membership:
                            status: active
                            invitation: null
                          participation:
                            decision: opt_in
                            decidedAt: '2026-09-25T15:00:00Z'
                          coverage:
                            status: enrolled
                            startsAt: '2026-10-01T00:00:00Z'
                            endsAt: null
                            planTier: example_tier
                          createdAt: '2026-09-20T15:00:00Z'
                          updatedAt: '2026-10-12T15:00:00Z'
                      createdAt: '2026-09-20T15:00:00Z'
                      updatedAt: '2026-10-12T15:00:00Z'
        '404':
          description: Person absent or has no employment in an authorized company.
      security:
        - bearerAuth: []
components:
  schemas:
    Person:
      type: object
      properties:
        id:
          type: string
          description: Person UUID.
          format: uuid
        employments:
          type: array
          description: Complete Employee objects in authorized companies.
          items:
            $ref: '#/components/schemas/Employee'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          description: Person-row timestamp; not a watermark for nested employment data.
          format: date-time
    Employee:
      type: object
      properties:
        id:
          type: string
          description: Employee-record UUID.
          format: uuid
        companyId:
          type: string
          description: Company ID.
        personId:
          type:
            - string
            - 'null'
          description: Linked Person UUID; null when identity is unresolved.
          format: uuid
        externalIds:
          type: array
          description: Identifiers in external systems.
          items:
            type: object
            properties:
              system:
                type: string
              system_id:
                type: string
        demographics:
          type: object
          properties:
            firstName:
              type: string
            lastName:
              type: string
            dateOfBirth:
              type: string
              format: date
            gender:
              type:
                - string
                - 'null'
        contact:
          type: object
          properties:
            email:
              type: string
            phone:
              type: string
            address:
              type: object
              properties:
                line1:
                  type: string
                line2:
                  type:
                    - string
                    - 'null'
                city:
                  type: string
                state:
                  type: string
                postalCode:
                  type: string
        membership:
          type: object
          properties:
            status:
              type: string
              description: >-
                Derived from membership, invitation, and linked user state;
                membership takes precedence.
              enum:
                - not_invited
                - invited_pending
                - invited_expired
                - active
                - revoked_access
            invitation:
              type:
                - object
                - 'null'
              properties:
                status:
                  type: string
                invitedAt:
                  type: string
                  format: date-time
                expiresAt:
                  type: string
                  format: date-time
        participation:
          type:
            - object
            - 'null'
          description: >-
            Null when no applicable participation record exists; selection
            across multiple plan programs is pending.
          properties:
            decision:
              type:
                - string
                - 'null'
              enum:
                - opt_in
                - opt_out
                - null
            decidedAt:
              type:
                - string
                - 'null'
              format: date-time
        coverage:
          type:
            - object
            - 'null'
          description: >-
            Null when no applicable coverage record exists; selection across
            multiple plan programs is pending.
          properties:
            status:
              type: string
              enum:
                - enrolled
                - enrolled_not_paying
                - awaiting_coverage
                - waived
                - terminated
            startsAt:
              type: string
              format: date-time
            endsAt:
              type:
                - string
                - 'null'
              format: date-time
            planTier:
              type:
                - string
                - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      description: >-
        Draft shared Employee object. Participation and coverage are separate
        from membership; record selection across multiple plan programs is
        pending.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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