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

# Profile objects

> The orders, tickets and invoices tied to a profile.



## OpenAPI

````yaml openapi/en/cell.json GET /v1/profiles/{profile_id}/objects
openapi: 3.1.0
info:
  title: Niadra data API
  version: '1'
  description: >-
    Writing, context, history, objects, identity, privacy and governance of one
    space. Every space has a stable address, with the space and the region in
    its name.
servers:
  - url: https://{space}.{region}.api.niadra.com
    variables:
      space:
        default: acme-prod
        description: The space, which comes in the source key.
      region:
        default: us-east-1
        description: The region of the space, which also comes in the key.
security: []
paths:
  /v1/profiles/{profile_id}/objects:
    get:
      tags:
        - governance
      summary: Profile objects
      description: >-
        The orders, tickets and invoices tied to a profile, with their derived
        state and the actions of agents on each, plus actions that belong to no
        listed object. The official values stay in your systems. The read is
        recorded in the audit trail.


        **Authentication.** Console person token with the `security`, `review`,
        `analysis`, `integration` role (or admin), or a source key with the
        `admin` scope.
      operationId: profile_objects_v1_profiles__profile_id__objects_get
      parameters:
        - in: path
          name: profile_id
          required: true
          schema:
            format: uuid
            title: Profile Id
            type: string
          example: 0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e01
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileObjects'
              example:
                profile_id: 0192f7a1-5b10-7c3a-8e21-4d2f8a4c0e01
                audience: human
                policy_version: pol-14
                objects:
                  - id: obj_invoice_0823
                    ref:
                      type: invoice
                      namespace: erp
                      id: '0823'
                    role: owner
                    state:
                      status: credited
                      amount_due: 49.9
                      currency: USD
                    as_of: '2026-09-22T17:06:24Z'
                    source_id: src_erp
                    record_ref: erp://invoices/0823
                    actions:
                      - id: act_01J8ZK
                        operation: credit
                        result: $40 credit on the August bill
                        purpose: billing
                        status: confirmed
                        object_id: obj_invoice_0823
                        closes_item_id: oi_01J8ZJ
                        confirmed_by_event_id: 0192f7a1-6a2b-7d11-9c3e-1a2b3c4d5e03
                        occurred_at: '2026-09-22T17:06:21Z'
                        origin:
                          event_id: 0192f7a1-6a2b-7d11-9c3e-1a2b3c4d5e02
                          source_id: src_billing
                          channel: erp
                          kind: action
                          speaker: ai_agent
                          conversation_id: null
                          task_id: billing-7741
                          at: '2026-09-22T17:06:21Z'
                    masked: false
                actions: []
                withheld: {}
          description: The objects of the profile.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: The request does not match the contract.
      security:
        - sourceKey: []
        - personToken: []
components:
  schemas:
    ProfileObjects:
      additionalProperties: false
      properties:
        actions:
          description: Actions on no object of the list, e.g. one that closes a promise.
          items:
            $ref: '#/components/schemas/ActionOut'
          title: Actions
          type: array
        audience:
          $ref: '#/components/schemas/Audience'
        objects:
          items:
            $ref: '#/components/schemas/ProfileObject'
          title: Objects
          type: array
        policy_version:
          title: Policy Version
          type: string
        profile_id:
          title: Profile Id
          type: string
        withheld:
          additionalProperties:
            type: integer
          title: Withheld
          type: object
      required:
        - profile_id
        - policy_version
        - audience
      title: ProfileObjects
      type: object
    Problem:
      additionalProperties: false
      description: RFC 9457 problem details; `code` comes from the versioned error catalog.
      properties:
        code:
          title: Code
          type: string
        detail:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Detail
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Request Id
        status:
          title: Status
          type: integer
        title:
          title: Title
          type: string
        type:
          default: about:blank
          title: Type
          type: string
      required:
        - title
        - status
        - code
      title: Problem
      type: object
    ActionOut:
      additionalProperties: false
      description: >-
        What an agent did in a system for the customer, with its reconciliation
        status.
      properties:
        closes_item_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Closes Item Id
        confirmed_by_event_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Confirmed By Event Id
        id:
          title: Id
          type: string
        masked:
          default: false
          title: Masked
          type: boolean
        object_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Object Id
        occurred_at:
          format: date-time
          title: Occurred At
          type: string
        operation:
          title: Operation
          type: string
        origin:
          $ref: '#/components/schemas/Origin'
        purpose:
          anyOf:
            - type: string
            - type: 'null'
          title: Purpose
        result:
          anyOf:
            - type: string
            - type: 'null'
          description: None when absent or masked for this reader.
          title: Result
        status:
          $ref: '#/components/schemas/ActionStatus'
      required:
        - id
        - operation
        - status
        - result
        - occurred_at
        - origin
      title: ActionOut
      type: object
    Audience:
      enum:
        - customer_agent
        - internal_agent
        - human
        - reviewer
        - analyst
        - trigger_target
        - export
      title: Audience
      type: string
    ProfileObject:
      additionalProperties: false
      properties:
        actions:
          description: Newest first.
          items:
            $ref: '#/components/schemas/ActionOut'
          title: Actions
          type: array
        as_of:
          format: date-time
          title: As Of
          type: string
        id:
          title: Id
          type: string
        masked:
          default: false
          title: Masked
          type: boolean
        record_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Record Ref
        ref:
          $ref: '#/components/schemas/ObjectRef'
        role:
          enum:
            - owner
            - participant
          title: Role
          type: string
        source_id:
          title: Source Id
          type: string
        state:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: None when the policy masks it for this reader.
          title: State
      required:
        - id
        - ref
        - role
        - state
        - as_of
        - source_id
      title: ProfileObject
      type: object
    Origin:
      additionalProperties: false
      description: >-
        Provenance of an item: the event it came from, its source (agent or
        system), channel and time.
      properties:
        at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: At
        channel:
          anyOf:
            - type: string
            - type: 'null'
          title: Channel
        conversation_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Conversation Id
        event_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Event Id
        kind:
          anyOf:
            - $ref: '#/components/schemas/EventKind'
            - type: 'null'
        source_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Id
        speaker:
          anyOf:
            - $ref: '#/components/schemas/Speaker'
            - type: 'null'
        task_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Task Id
      title: Origin
      type: object
    ActionStatus:
      enum:
        - declared
        - confirmed
        - divergent
        - quarantined
      title: ActionStatus
      type: string
    ObjectRef:
      additionalProperties: false
      description: >-
        A business object in a system of record, e.g. `invoice` / `erp` /
        `0823`.
      properties:
        id:
          maxLength: 512
          minLength: 1
          title: Id
          type: string
          description: The id in that system.
        namespace:
          maxLength: 256
          minLength: 1
          title: Namespace
          type: string
          description: The system it lives in, such as `erp`.
        type:
          maxLength: 256
          minLength: 1
          title: Type
          type: string
          description: Object type, such as `invoice`, `order` or `ticket`.
      required:
        - type
        - namespace
        - id
      title: ObjectRef
      type: object
    EventKind:
      enum:
        - message
        - system_event
        - action
      title: EventKind
      type: string
      description: >-
        What an event records: something said, a change in a system of record,
        or what an agent did in a system.
    Speaker:
      enum:
        - customer
        - ai_agent
        - human_agent
        - system
      title: Speaker
      type: string
      description: Who produced the event.
  securitySchemes:
    sourceKey:
      type: http
      scheme: bearer
      description: nia_sk_...
    personToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````