TrustLayer reports API

openapi: 3.0.0
info:
  title: TrustLayer Platform Auth reports API
  version: '1.0'
  contact:
    name: TrustLayer Support
    email: support@trustlayer.io
  termsOfService: https://trustlayer.io/terms-of-service
  externalDocs:
    description: OpenAPI specification
    url: /v1/platform-api.yaml
  description: '3rd-party API for the TrustLayer platform.


    **Deprecated.** Platform API v1 is deprecated as of 01 June 2026 and is

    scheduled for sunset (end-of-life) on 31 March 2027. It remains fully

    available until the sunset date but will not receive new features. Please

    migrate to Platform API v2 for new integrations.


    All v1 responses carry the standard deprecation response headers

    ([RFC 8594](https://www.rfc-editor.org/rfc/rfc8594)):


    ```http

    Deprecation: @1780272000

    Sunset: Wed, 31 Mar 2027 23:59:59 GMT

    Link: <https://developers.trustlayer.io/>; rel="deprecation", <https://developers.trustlayer.io/>; rel="sunset"

    ```


    `Deprecation: @1780272000` is the Unix timestamp for 2026-06-01T00:00:00Z;

    sunset (end-of-life) is 2027-03-31T23:59:59 GMT.'
  x-deprecated: true
  x-deprecation-date: '2026-06-01'
  x-sunset: '2027-03-31'
  license:
    name: Apache 2.0
    url: https://apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:4000/v1
  description: Local
- url: https://api.trustlayer.io/v1
  description: Production
security:
- API Key: []
tags:
- name: reports
paths:
  /reports:
    get:
      summary: List public reports
      tags:
      - reports
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    $ref: '#/components/schemas/response-status'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/report'
                  meta:
                    $ref: '#/components/schemas/collection-meta'
      operationId: get-reports
      deprecated: true
      parameters:
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/sort'
      description: 'Available filter options:

        - `type` (either `projects` or `parties`)


        Available sort options:

        - `name`

        - `createdAt`

        '
      x-internal: false
    post:
      summary: Create a new report
      operationId: post-reports
      deprecated: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    $ref: '#/components/schemas/response-status'
                  data:
                    $ref: '#/components/schemas/report'
      description: TBD
      tags:
      - reports
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                report:
                  $ref: '#/components/schemas/report-create'
      x-internal: false
  /reports/{id}:
    parameters:
    - schema:
        type: string
      name: id
      in: path
      required: true
      description: Report ID
    get:
      summary: Fetch a public report
      tags:
      - reports
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    $ref: '#/components/schemas/response-status'
                  data:
                    $ref: '#/components/schemas/report'
      operationId: get-reports-:id
      deprecated: true
      description: TBD
      x-internal: false
    patch:
      summary: Update a report
      operationId: post-reports-:id-id
      deprecated: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    $ref: '#/components/schemas/response-status'
                  data:
                    $ref: '#/components/schemas/report'
      description: TBD
      tags:
      - reports
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                report:
                  $ref: '#/components/schemas/report-update'
      x-internal: false
    delete:
      summary: Delete a report
      operationId: delete-reports-:id-id
      deprecated: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    $ref: '#/components/schemas/response-status'
                  data:
                    $ref: '#/components/schemas/report'
      tags:
      - reports
      description: TBD
      x-internal: false
components:
  parameters:
    filter:
      name: filter
      in: query
      required: false
      schema:
        type: object
        example:
          title: foo
      style: deepObject
      description: Key-value pair, e.g. filter[key]=value
    sort:
      name: sort
      in: query
      required: false
      schema:
        type: string
        example: name,-age
      description: List of comma-separated keys used to sort. Reversing is done by prepending "-" to the key name.
      allowReserved: true
  schemas:
    report-update:
      description: ''
      type: object
      x-examples: {}
      properties:
        name:
          type: string
          minLength: 1
        filters:
          type: object
          minProperties: 1
      title: report-update
      x-tags:
      - input
      x-internal: true
    response-status:
      type: string
      title: Response Status
      enum:
      - success
      - fail
      - error
      readOnly: true
      x-examples:
        Success: success
      description: The possible values are "success", "fail", and "error".
      x-internal: true
    report-create:
      type: object
      title: report-create
      x-examples: {}
      x-internal: true
      additionalProperties: false
      properties:
        name:
          type: string
        filters:
          type: object
          minProperties: 1
        reportType:
          type: string
          enum:
          - parties
          - projects
      required:
      - name
      - filters
      - reportType
      x-tags:
      - input
    report:
      title: Report
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          default: reports
        name:
          type: string
        filters:
          type: object
        updatedAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
      x-examples:
        Example report:
          id: 60be22526a69195b1941d77e
          type: reports
          name: Interesting projects
          filters:
            name: interesting
            view: table
            sortField: name
            sortDirection: asc
          updatedAt: '2019-08-24T14:15:22Z'
          createdAt: '2019-08-24T14:15:22Z'
    collection-meta:
      title: collection-meta
      type: object
      properties:
        count:
          type: number
          description: The number of documents according to the specified filters
        pages:
          type: number
        totalCount:
          type: number
          description: The total number of documents in the collection
        totalPages:
          type: number
      x-internal: true
  securitySchemes:
    Token:
      name: Authorization
      type: apiKey
      in: header
      description: ''