VoidhashDocs
DocumentationAPI reference
Dashboard
Essentials
API overview
Authentication
Endpoints
Ad_accounts
Analytics
Api_keys
Auth
Component_dev_sessions
Component_registry
Components
Development
Events
Experiments
Feature_flag_overrides
Feature_flag_targets
Feature_flags
Ingest_policy
Notification_sends
Notifications
Organizations
Payment_provider_configurations
Payment_provider_products
Payment_sources
Paywall_locations
Paywalls
Perks
Persons
Products
Projects
Push_notification_configurations
Schema
Sdk
Users
Webhooks
Audit_log
Organization_members
Notices
Connected_apps
Tracking_domains
Ads
Payment_provider_history_imports
Feedback
Analytics
Event capture
Get Component Publisher
Claim Component Publisher
List Registry Components
Get Registry Component
Read Registry Component File
Publish Registry Component
Promote Component Version
Set Registry Version Status
Set Registry Component Deprecation
Transfer Registry Component
List Component Installs
Install Component
Review Component Install
Update Component Install
Uninstall Component

Get Registry Component

PreviousList Registry ComponentsNextRead Registry Component File
GET
/api/v1/component-registry/components/{publisher}/{name}

Path Parameters

publisher*string
name*string

Query Parameters

projectId?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/component-registry/components/string/string"
{  "category": "string",  "componentId": "string",  "createdAt": "string",  "deprecatedAt": "string",  "deprecationMessage": "string",  "description": "string",  "install": {    "componentId": "string",    "consentedCapabilities": [      "string"    ],    "createdAt": "string",    "installId": "string",    "installedBy": "string",    "updatedAt": "string",    "version": {      "bundleHash": "string",      "byteSize": 0,      "capabilities": [        "string"      ],      "componentId": "string",      "contentHash": "string",      "createdBy": "string",      "definition": null,      "hasAgentGuide": true,      "hasIcon": true,      "hasPanel": true,      "hasReadme": true,      "manifest": null,      "number": 0,      "publishedAt": "string",      "status": "ready",      "statusMessage": "string",      "thumbnailStates": [        "string"      ],      "version": "string",      "versionId": "string",      "warnings": [        "conformance-not-run"      ],      "conformance": {        "hasPassed": true,        "checks": [          {            "name": "string",            "status": "pass",            "errors": [              "string"            ],            "warnings": [              "string"            ]          }        ]      }    },    "versionRange": "string"  },  "keywords": [    "string"  ],  "latestVersion": {    "bundleHash": "string",    "byteSize": 0,    "capabilities": [      "string"    ],    "componentId": "string",    "contentHash": "string",    "createdBy": "string",    "definition": null,    "hasAgentGuide": true,    "hasIcon": true,    "hasPanel": true,    "hasReadme": true,    "manifest": null,    "number": 0,    "publishedAt": "string",    "status": "ready",    "statusMessage": "string",    "thumbnailStates": [      "string"    ],    "version": "string",    "versionId": "string",    "warnings": [      "conformance-not-run"    ],    "conformance": {      "hasPassed": true,      "checks": [        {          "name": "string",          "status": "pass",          "errors": [            "string"          ],          "warnings": [            "string"          ]        }      ]    }  },  "name": "string",  "ownerProject": {    "id": "string",    "name": "string"  },  "publisher": "string",  "title": "string",  "updatedAt": "string",  "versionCount": 0,  "agentGuide": "string",  "readme": "string",  "versions": [    {      "bundleHash": "string",      "byteSize": 0,      "capabilities": [        "string"      ],      "componentId": "string",      "contentHash": "string",      "createdBy": "string",      "definition": null,      "hasAgentGuide": true,      "hasIcon": true,      "hasPanel": true,      "hasReadme": true,      "manifest": null,      "number": 0,      "publishedAt": "string",      "status": "ready",      "statusMessage": "string",      "thumbnailStates": [        "string"      ],      "version": "string",      "versionId": "string",      "warnings": [        "conformance-not-run"      ],      "conformance": {        "hasPassed": true,        "checks": [          {            "name": "string",            "status": "pass",            "errors": [              "string"            ],            "warnings": [              "string"            ]          }        ]      },      "usage": {        "installs": 0,        "publishedPaywalls": 0      }    }  ]}
{  "_tag": "Api/SdkValidationError",  "message": "string"}
{  "_tag": "Api/AuthenticationError",  "cause": "string",  "message": "string"}
{  "_tag": "Api/ActionForbiddenError",  "message": "string"}
{  "_tag": "Api/ComponentNotFoundError",  "message": "string"}
{  "_tag": "Api/ComponentServiceError",  "message": "string"}