> ## Documentation Index > Fetch the complete documentation index at: https://docs.reelevant.com/llms.txt > Use this file to discover all available pages before exploring further. # List contents ## OpenAPI ````yaml https://openapi.production.reelevant.io/v1/render/contents-api get /contents openapi: 3.0.0 info: title: contents-api version: f9a1b334ed88c96ed84665c78dcdba64fc9f2b14 description: |- # Errors | Error code | Message | HTTP status code | Payload | | :--- | :--- | :--- | :--- | | number | string | 404 | | servers: - url: https://api.reelevant.com/v2/ description: production security: [] paths: /contents: get: tags: - Content summary: List contents operationId: list-content parameters: - name: ids in: query schema: type: array items: type: string description: Filter on contents that have on of those ids required: false - name: name in: query schema: type: string description: Filter on contents that contains that string in the name required: false - name: resourceGroupIds in: query schema: type: array items: type: string description: Filter on contents with on of those resource groups required: false - name: status in: query schema: type: array items: $ref: '#/components/schemas/ContentStatus' description: Filter on contents with one of those statuses required: false - name: includeArchived in: query schema: type: boolean default: null description: Display archived contents required: false - name: includeHidden in: query schema: type: boolean default: null description: Display hidden contents required: false - name: sortBy in: query schema: oneOf: - type: string enum: - name - type: string enum: - createdAt - type: string enum: - updatedAt default: updatedAt required: false - name: sortOrder in: query schema: oneOf: - type: string enum: - desc - type: string enum: - asc default: desc required: false - name: hierarchy in: query schema: type: array items: type: string description: >- Filter on contents with a specific hierarchy path. Pass an array of strings representing the folder path (e.g., ["Marketing", "Q4"] for Marketing > Q4). Empty array returns root-level contents. required: false - name: includeLiveOnly in: query schema: type: boolean default: null description: >- Filter on contents with live data and return only live version. Note: when using this option, the `status` will always be `PUBLISHED` required: false - name: select in: query schema: type: array items: type: string description: >- List of fields you want to get, by default the whole content with versions is returned. But you can choose to return only ['name'] to have data: [{ id: 'bar', name: 'foo' }]. Note: `id` is always returned required: false - name: page in: query schema: type: number default: 1 minimum: 1 required: false - name: perPage in: query schema: type: number default: 10 minimum: 1 required: false responses: '200': description: Ok content: application/json: schema: allOf: - type: object properties: paginationCount: type: number paginationPage: type: number paginationLimit: type: number required: - paginationCount - paginationPage - paginationLimit additionalProperties: false - type: object properties: status: type: string enum: - success required: - status additionalProperties: false - $ref: '#/components/schemas/InternalResponse_Array_Content' security: - password_auth: [] components: schemas: ContentStatus: type: string enum: - draft - publishing - published - error InternalResponse_Array_Content: type: object properties: program: type: string version: type: string datetime: type: string status: type: string code: type: number message: type: string data: type: array items: $ref: '#/components/schemas/Content' required: - program - version - datetime - status - message - data additionalProperties: false Content: $ref: '#/components/schemas/SerializedContent' SerializedContent: allOf: - $ref: >- #/components/schemas/Content_Without_CompanyId_ResourceGroupIds_ToJSON__id_Versions - type: object properties: companyId: type: string resourceGroupIds: type: array items: type: string versions: type: array items: $ref: '#/components/schemas/SerializedContentVersions' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - companyId - resourceGroupIds - versions - createdAt - updatedAt Content_Without_CompanyId_ResourceGroupIds_ToJSON__id_Versions: type: object properties: name: type: string id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time hierarchy: type: array items: type: string options: allOf: - $ref: '#/components/schemas/ContentOptions' description: >- Options are used to toggle specific behavior when rendering the content description: type: string status: allOf: - $ref: '#/components/schemas/ContentStatus' readOnly: true description: This status is used to know if a content can be rendered or not archivedAt: type: string format: date-time nullable: true readOnly: true hidden: type: boolean required: - name - id - hierarchy - status - archivedAt - hidden additionalProperties: false SerializedContentVersions: allOf: - $ref: '#/components/schemas/ContentVersion_Without_ToJSON__id' - type: object properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - createdAt - updatedAt ContentOptions: type: object properties: compression: type: boolean compressionThreshold: type: number required: - compression - compressionThreshold additionalProperties: false ContentVersion_Without_ToJSON__id: type: object properties: id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time template: allOf: - $ref: '#/components/schemas/BaseTemplate' description: Content template definition state: allOf: - $ref: '#/components/schemas/ContentVersionState' readOnly: true description: |- The state of the version. If state=draft, it means this is the draft version, where updates occurs. If state=live, it means this is the live version used to render the content, it won't be updated again previewUrl: type: string description: URL of the preview img to show in workflows, generated on publish metadata: type: object properties: {} additionalProperties: $ref: '#/components/schemas/AnyValue' description: This is used by the frontend to store their metadata required: - id - template - state additionalProperties: false BaseTemplate: type: object properties: components: type: object properties: {} additionalProperties: type: object properties: name: type: string type: type: string rendered: type: boolean options: type: object properties: {} additionalProperties: $ref: '#/components/schemas/AnyValue' required: - type - rendered - options additionalProperties: false description: Map of components, key is the component id dependencies: type: object properties: {} additionalProperties: type: object properties: type: type: string options: type: object properties: {} additionalProperties: $ref: '#/components/schemas/AnyValue' required: - type - options additionalProperties: false description: Map of dependencies, key is the component id pages: type: array items: allOf: - type: object properties: id: type: string width: type: number height: type: number background: type: object properties: r: type: number g: type: number b: type: number a: type: number required: - r - g - b - a additionalProperties: false duration: type: number components: type: array items: type: object properties: id: type: string description: Component id x: type: number 'y': type: number skewX: type: number skewY: type: number width: type: number height: type: number rotation: type: number required: - id - x - 'y' - skewX - skewY - width - height - rotation additionalProperties: false orderTree: type: object properties: root: type: array items: type: string elements: type: object properties: {} additionalProperties: oneOf: - type: object properties: type: type: string enum: - conditionGroup required: - type additionalProperties: false - type: object properties: type: type: string enum: - condition children: type: array items: type: string required: - type - children additionalProperties: false - type: object properties: type: type: string enum: - component required: - type additionalProperties: false - type: object properties: type: type: string enum: - componentGroup children: type: array items: type: string required: - type - children additionalProperties: false required: - root - elements additionalProperties: false required: - id - width - height - background - duration - components - orderTree additionalProperties: false - type: object properties: url: type: array items: oneOf: - type: object properties: type: type: string enum: - static value: type: string required: - type - value additionalProperties: false - type: object properties: type: type: string enum: - dependency value: type: string required: - type - value additionalProperties: false title: type: array items: oneOf: - type: object properties: type: type: string enum: - static value: type: string required: - type - value additionalProperties: false - type: object properties: type: type: string enum: - dependency value: type: string required: - type - value additionalProperties: false additionalProperties: false description: Map of pages in the template sorted by position conditionGroups: type: object properties: {} additionalProperties: allOf: - type: object properties: name: type: string description: name of a component group additionalProperties: false - type: object properties: conditions: type: array items: oneOf: - type: object properties: id: type: string description: Condition id type: oneOf: - type: string enum: - and - type: string enum: - or description: >- Type of condition - and: all conditions must be truthy to render components - or: one of conditions must be truthy to render components rules: type: array items: type: object properties: field: oneOf: - type: object properties: type: type: string enum: - static value: oneOf: - type: string - type: number - type: boolean enum: - 'false' - type: boolean enum: - 'true' required: - type - value additionalProperties: false - type: object properties: type: type: string enum: - dependency value: type: string description: dependency id required: - type - value additionalProperties: false operator: oneOf: - type: string enum: - $gte - type: string enum: - $gt - type: string enum: - $lt - type: string enum: - $lte - type: string enum: - $eq - type: string enum: - $ne - type: string enum: - $contains - type: string enum: - $notcontains - type: string enum: - $empty - type: string enum: - $nempty - type: string enum: - $rangefuture - type: string enum: - $rangepast - type: string enum: - $nrangefuture - type: string enum: - $nrangepast value: type: array items: oneOf: - type: object properties: type: type: string enum: - static value: oneOf: - type: string - type: number - type: boolean enum: - 'false' - type: boolean enum: - 'true' required: - type - value additionalProperties: false - type: object properties: type: type: string enum: - dependency value: type: string description: dependency id required: - type - value additionalProperties: false required: - field - operator - value additionalProperties: false required: - id - type - rules additionalProperties: false - type: object properties: id: type: string description: Condition id type: oneOf: - type: string enum: - and - type: string enum: - or description: >- Type of condition - and: all conditions must be truthy to render components - or: one of conditions must be truthy to render components rules: type: array items: type: object properties: field: oneOf: - type: object properties: type: type: string enum: - static value: oneOf: - type: string - type: number - type: boolean enum: - 'false' - type: boolean enum: - 'true' required: - type - value additionalProperties: false - type: object properties: type: type: string enum: - dependency value: type: string description: dependency id required: - type - value additionalProperties: false operator: oneOf: - type: string enum: - $gte - type: string enum: - $gt - type: string enum: - $lt - type: string enum: - $lte - type: string enum: - $eq - type: string enum: - $ne - type: string enum: - $contains - type: string enum: - $notcontains - type: string enum: - $empty - type: string enum: - $nempty - type: string enum: - $rangefuture - type: string enum: - $rangepast - type: string enum: - $nrangefuture - type: string enum: - $nrangepast value: type: array items: oneOf: - type: object properties: type: type: string enum: - static value: oneOf: - type: string - type: number - type: boolean enum: - 'false' - type: boolean enum: - 'true' required: - type - value additionalProperties: false - type: object properties: type: type: string enum: - dependency value: type: string description: dependency id required: - type - value additionalProperties: false required: - field - operator - value additionalProperties: false required: - id - type - rules additionalProperties: false - type: object properties: id: type: string isElse: type: boolean enum: - 'true' required: - id - isElse additionalProperties: false description: >- List of conditions to execute, if the first one is truthy we render attached components and ignore others If the condition is falsy we execute the next one in the list or fallback and render components in `elseComponents` list required: - conditions additionalProperties: false description: Map of condition groups, key is the condition id componentGroups: type: object properties: {} additionalProperties: allOf: - type: object properties: rendered: type: boolean description: true if we need to render the component group required: - rendered additionalProperties: false - type: object properties: url: type: array items: oneOf: - type: object properties: type: type: string enum: - static value: type: string required: - type - value additionalProperties: false - type: object properties: type: type: string enum: - dependency value: type: string required: - type - value additionalProperties: false description: URL to redirect when clicked on component group name: type: string description: name of a component group additionalProperties: false description: Map of component groups, key is the component group id editorSettings: type: object properties: canvasBackground: type: object properties: r: type: number g: type: number b: type: number a: type: number required: - r - g - b - a additionalProperties: false description: |- Background color of the editor canvas area. Purely cosmetic — does not affect generated content output. layoutGuides: type: array items: oneOf: - allOf: - type: object properties: id: type: string name: type: string visible: type: boolean color: type: object properties: r: type: number g: type: number b: type: number a: type: number required: - r - g - b - a additionalProperties: false required: - id - name - visible - color additionalProperties: false - type: object properties: type: type: string enum: - grid size: type: number required: - type - size additionalProperties: false - allOf: - type: object properties: id: type: string name: type: string visible: type: boolean color: type: object properties: r: type: number g: type: number b: type: number a: type: number required: - r - g - b - a additionalProperties: false required: - id - name - visible - color additionalProperties: false - type: object properties: type: type: string enum: - columns count: type: number gutterSize: type: number margin: type: number alignment: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - stretch required: - type - count - gutterSize - margin - alignment additionalProperties: false - type: object properties: width: type: number nullable: true additionalProperties: false - allOf: - type: object properties: id: type: string name: type: string visible: type: boolean color: type: object properties: r: type: number g: type: number b: type: number a: type: number required: - r - g - b - a additionalProperties: false required: - id - name - visible - color additionalProperties: false - type: object properties: type: type: string enum: - rows count: type: number gutterSize: type: number margin: type: number alignment: oneOf: - type: string enum: - center - type: string enum: - top - type: string enum: - stretch required: - type - count - gutterSize - margin - alignment additionalProperties: false - type: object properties: height: type: number nullable: true additionalProperties: false description: |- Layout guides for the editor canvas (grids, columns, rows). Purely cosmetic — does not affect generated content output. additionalProperties: false description: Editor-only settings that do not affect content rendering output required: - components - dependencies - pages - conditionGroups - componentGroups additionalProperties: false ContentVersionState: type: string enum: - draft - live - inactive AnyValue: description: Can be any value nullable: true securitySchemes: password_auth: type: oauth2 flows: password: tokenUrl: https://api.reelevant.com/v1/auth/token refreshUrl: https://api.reelevant.com/v1/auth/token scopes: {} ````