---
updatedAt: 2025-04-23T20:40:06.000Z
agentTools:
  projectIndex: https://developer.threekit.com/llms.txt
---

# Get All Experiences

Retrieve all the Experiences.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Catalog 2.0 Discovery AI",
    "description": "Work with Discovery AI Experiences.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://preview.threekit.com/api"
    }
  ],
  "tags": [
    {
      "name": "Discovery AI Experience",
      "description": "Work with the New Catalog"
    }
  ],
  "paths": {
    "/experiences": {
      "get": {
        "summary": "Get All Experiences",
        "description": "Retrieve all the Experiences.",
        "tags": [
          "Discovery AI Experience"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "bearer_token",
            "description": "Public or Private Threekit authentication token. If using a public token the request must originate for a domain added to the authentication token.",
            "schema": {
              "type": "string",
              "format": "uuid",
              "description": "Public or Private Threekit authentication token. If using a public token the request must originate for a domain added to the authentication token."
            },
            "required": true
          },
          {
            "in": "query",
            "name": "page",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "exclusiveMinimum": true,
              "default": 1,
              "description": "The page number to retrieve."
            }
          },
          {
            "in": "query",
            "name": "perPage",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "exclusiveMinimum": true,
              "maximum": 100,
              "default": 50,
              "description": "The number of entities to retrieve per page."
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200 OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "page": {
                      "type": "integer",
                      "minimum": 0,
                      "exclusiveMinimum": true,
                      "default": 1
                    },
                    "perPage": {
                      "type": "integer",
                      "minimum": 0,
                      "exclusiveMinimum": true,
                      "maximum": 100,
                      "default": 50
                    },
                    "count": {
                      "type": "integer",
                      "minimum": 0,
                      "example": 1
                    },
                    "sort": {
                      "type": "string"
                    },
                    "experiences": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "format": "uuid",
                            "title": "Threekit UUID",
                            "description": "A UUID that uniquely identifies an entity in the Threekit platform."
                          },
                          "orgId": {
                            "type": "string",
                            "format": "uuid",
                            "title": "Threekit UUID",
                            "description": "A UUID that uniquely identifies an entity in the Threekit platform."
                          },
                          "name": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 255,
                            "description": "A unique user-defined name for the entity.",
                            "example": "My Chair"
                          },
                          "customId": {
                            "type": "string",
                            "nullable": true,
                            "pattern": "^[\\w\\-:]*$",
                            "maxLength": 255,
                            "default": null,
                            "example": "SKU-1234",
                            "title": "Custom ID",
                            "description": "A unique, user-defined identifier. Can only contain alphanumeric characters, hyphens, underscores and colons."
                          },
                          "label": {
                            "type": "string",
                            "nullable": true,
                            "maxLength": 255,
                            "description": "A user-defined label.",
                            "example": "Small Modern Chair",
                            "default": null
                          },
                          "description": {
                            "type": "string",
                            "nullable": true,
                            "maxLength": 2500,
                            "description": "A user-defined description.",
                            "example": "A modern minimalist chair good for small spaces.",
                            "default": null
                          },
                          "experienceData": {
                            "type": "object",
                            "properties": {
                              "title": {
                                "type": "string",
                                "maxLength": 255
                              },
                              "placeholderText": {
                                "type": "string",
                                "maxLength": 255
                              },
                              "mainColor": {
                                "type": "string",
                                "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
                              },
                              "accentColor": {
                                "type": "string",
                                "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"
                              },
                              "customLogo": {
                                "type": "string",
                                "nullable": true,
                                "format": "uuid",
                                "title": "Threekit UUID",
                                "description": "The file UUID of a file uploaded to the files service."
                              },
                              "rephrasePromptId": {
                                "type": "string",
                                "nullable": true,
                                "format": "uuid",
                                "title": "Threekit UUID",
                                "description": "The UUID of a Prompt to use for rephrasing the user's query."
                              },
                              "confidencePromptId": {
                                "type": "string",
                                "nullable": true,
                                "format": "uuid",
                                "title": "Threekit UUID",
                                "description": "The UUID of a Prompt to use for creating the confidence message."
                              },
                              "rerankGuidancePromptId": {
                                "type": "string",
                                "nullable": true,
                                "format": "uuid",
                                "title": "Threekit UUID",
                                "description": "The UUID of a Prompt to use for guiding the reranking process.",
                                "default": null
                              },
                              "questions": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "name": {
                                      "type": "string",
                                      "maxLength": 255
                                    },
                                    "questionText": {
                                      "type": "string",
                                      "maxLength": 255
                                    },
                                    "choices": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "properties": {
                                          "label": {
                                            "type": "string",
                                            "maxLength": 255
                                          },
                                          "vectorPrompt": {
                                            "type": "string",
                                            "nullable": true,
                                            "maxLength": 255,
                                            "default": null
                                          },
                                          "thumbnail": {
                                            "type": "string",
                                            "nullable": true,
                                            "format": "uuid",
                                            "title": "Threekit UUID",
                                            "description": "A UUID that uniquely identifies an entity in the Threekit platform.",
                                            "default": null
                                          }
                                        },
                                        "required": [
                                          "label",
                                          "vectorPrompt",
                                          "thumbnail"
                                        ]
                                      },
                                      "maxItems": 100,
                                      "default": []
                                    }
                                  },
                                  "required": [
                                    "name",
                                    "questionText",
                                    "choices"
                                  ]
                                },
                                "maxItems": 100
                              },
                              "moderationEnabled": {
                                "type": "boolean",
                                "default": true
                              }
                            },
                            "required": [
                              "title",
                              "placeholderText",
                              "mainColor",
                              "accentColor",
                              "customLogo",
                              "rephrasePromptId",
                              "confidencePromptId",
                              "rerankGuidancePromptId",
                              "questions",
                              "moderationEnabled"
                            ],
                            "description": "The data that will be used to configure the Experience App."
                          },
                          "createdAt": {
                            "type": "string",
                            "description": "Timestamp for when the Experience was created."
                          },
                          "createdBy": {
                            "type": "string",
                            "format": "uuid",
                            "description": "Threekit UUID for user who created the Experience."
                          },
                          "updatedAt": {
                            "type": "string",
                            "description": "Timestamp for when the Experience was last updated or when it was created if no updates have been made."
                          },
                          "updatedBy": {
                            "type": "string",
                            "format": "uuid",
                            "description": "Threekit UUID for the user who updated the Experience or who created it if no updates have been made."
                          },
                          "deletedAt": {
                            "type": "string",
                            "nullable": true,
                            "description": "Timestamp for when the Experience deleted."
                          },
                          "deletedBy": {
                            "type": "string",
                            "nullable": true,
                            "format": "uuid",
                            "title": "Threekit UUID",
                            "description": "Threekit UUID for the user who deleted the Experience."
                          }
                        },
                        "required": [
                          "id",
                          "orgId",
                          "name",
                          "customId",
                          "label",
                          "description",
                          "experienceData",
                          "createdAt",
                          "createdBy",
                          "updatedAt",
                          "updatedBy",
                          "deletedAt",
                          "deletedBy"
                        ]
                      }
                    }
                  },
                  "required": [
                    "page",
                    "perPage",
                    "count",
                    "sort",
                    "experiences"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "number",
                      "enum": [
                        400
                      ]
                    },
                    "code": {
                      "type": "string",
                      "minLength": 1
                    },
                    "message": {
                      "type": "string",
                      "minLength": 1
                    }
                  },
                  "required": [
                    "status",
                    "code",
                    "message"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}
```