Penpot

Penpot Get Profiles For File Comments API

The Get Profiles For File Comments API from Penpot — 1 operation(s) for get profiles for file comments.

GitHub OpenAPI

Documentation

📖
Documentation
https://help.penpot.app/technical-guide/integration/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/penpot/refs/heads/main/openapi/penpot-get-profiles-for-file-comments-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/penpot/refs/heads/main/json-schema/penpot-schemas.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/penpot/refs/heads/main/examples/penpot-request-examples.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/penpot/refs/heads/main/vocabulary/penpot-vocabulary.yml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/penpot/refs/heads/main/json-ld/penpot-context.jsonld

OpenAPI Specification

penpot-get-profiles-for-file-comments-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  version: '2.16'
  title: Penpot RPC Add Team To Organization Get Profiles For File Comments API
  description: Penpot RPC-style REST API for projects, files, pages, components, and design assets.
  x-api-id: penpot-rpc
  contact:
    url: https://community.penpot.app/
    name: Penpot Support
  x-humanURL: https://penpot.app/integrations-api
servers:
- url: https://design.penpot.app/api/main/methods
  description: MAIN API
tags:
- name: Get Profiles For File Comments
paths:
  get-profiles-for-file-comments:
    post:
      description: 'Retrieves a list of profiles with limited set of properties of all

        participants on comment threads of the file.'
      deprecated: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              title: get-profiles-for-file-comments
              type: object
              properties:
                fileId:
                  $ref: '#/components/schemas/Uuid'
                shareId:
                  $ref: '#/components/schemas/Uuid'
                  nullable: true
              required:
              - fileId
            example: '{"fileId":"5ab5eb30-5b3a-81d5-8008-2a395c60a2c1"}'
      tags:
      - Get Profiles For File Comments
components:
  schemas:
    Uuid:
      title: uuid
      description: UUID formatted string
      type: string
      format: uuid