Skip to main content
GET
/
v1
/
parts
/
{id}
Get Part
curl --request GET \
  --url https://api.example.com/v1/parts/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "title": "<string>",
  "serialId": 123,
  "ipOwnerId": "<string>",
  "internal": true,
  "published": true,
  "requireSubscription": true,
  "keywords": [
    "<string>"
  ],
  "createdTime": "2023-11-07T05:31:56Z",
  "modifiedTime": "2023-11-07T05:31:56Z",
  "parentId": "<string>",
  "versionName": "<string>",
  "externalRef": "<string>",
  "description": "<string>"
}

Path Parameters

​
id
string
required

Part id.

Response

The request has succeeded.

​
id
string
required

Part id.

​
title
string
required

Title of the part.

​
serialId
integer<int32>
required

Part serial id.

​
ipOwnerId
string
required

IP owner organization id.

​
internal
boolean
required

Whether the part is internal.

​
published
boolean
required

Whether the part is published.

​
requireSubscription
boolean
required

Whether the part requires a subscription.

​
keywords
string[]
required

Keywords of the part.

​
createdTime
string<date-time>
required

Time when the part was created.

​
modifiedTime
string<date-time>
required

Time when the part was modified.

​
parentId
string

Part parent id (if versioned).

​
versionName
string

Version name of the part.

​
externalRef
string

External reference for the part.

​
description
string

Description of the part.