Product details

Show details of a product

Sparse Fields

Use the fields[products] parameter to request only specific attributes:

Get only title and publish_status fields

• GET /v1/products/123?fields[products]=title,publish_status

Response will only include the requested fields

{
  "data": {
    "id": "123",
    "type": "products",
    "attributes": {
      "title": "Advanced Course",
      "publish_status": "published"
    },
    "relationships": {}
  }
}

GET /v1/products/{id}

Product details

cURL

curl --request GET \
  --url https://api.kajabi.com/v1/products/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "title": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "status": "<string>",
      "members_aggregate_count": 123,
      "product_type_name": "<string>",
      "product_type_id": 123,
      "publish_status": "<string>",
      "thumbnail_url": "<string>",
      "url": "<string>"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      }
    }
  },
  "links": {
    "self": "<string>",
    "current": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Query Parameters

fields[products] · string

Partial attributes as specified, e.g. fields[products]=title,publish_status

Response

200

application/vnd.api+json

Success, shows details of a product

data · object

Show child attributes

links · object

Show child attributes