Skip to main content
GET
Get Product

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Product OId

Response

Product data

_metadata
object
required
oId
string
required

The ID of the product

Minimum string length: 1
Example:

"p_1234"

createdAt
string<date-time>
required

The date and time the product was created

Example:

"2021-01-01"

data
object
required
user
object
required
workspace
object
required
updatedAt
string<date-time> | null

The date and time the product was updated

Example:

"2021-01-01"

archivedAt
string<date-time> | null

The date and time the product was archived

Example:

"2021-01-01"

deletedAt
string<date-time> | null

The date and time the product was deleted

Example:

"2021-01-01"

name
string | null

The external facing name of the product

Example:

"Product Name"

internalName
string | null

The internal name of the product

Example:

"Product Internal Name"

description
string | null

The description of the product

Example:

"Product Description"

primaryUrl
string | null

The primary URL of the product

Example:

"https://www.product.com"

active
boolean
default:true

Whether the product is active and can be used

Example:

true

qualifyingQuestions
object[] | null