Examples

GET /katello/api/content_views
200
{
  "total": 15,
  "subtotal": 15,
  "selectable": 15,
  "page": 1,
  "per_page": 20,
  "error": null,
  "search": null,
  "sort": {
    "by": "name",
    "order": "asc"
  },
  "results": [
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": true,
      "version_count": 1,
      "latest_version": "1.0",
      "latest_version_id": 840492357,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": true,
      "repository_ids": [
        103207400,
        920815232,
        16447009
      ],
      "id": 30237652,
      "name": "ACME Default ContentView",
      "label": "org_default_label",
      "description": "A content view",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [
        {
          "id": 562075838,
          "name": "Library",
          "label": "library_label"
        }
      ],
      "repositories": [
        {
          "id": 103207400,
          "name": "RHEL 6 x86_64",
          "label": "rhel_6_x86_64_label",
          "content_type": "yum"
        },
        {
          "id": 920815232,
          "name": "Fedora 17 x86_64",
          "label": "fedora_17_x86_64_label",
          "content_type": "yum"
        },
        {
          "id": 16447009,
          "name": "Pulp3 Python 1",
          "label": "Pulp3_Python_1",
          "content_type": "python"
        }
      ],
      "versions": [
        {
          "id": 840492357,
          "version": "1.0",
          "published": "2024-05-23 19:46:01 UTC",
          "description": null,
          "environment_ids": [
            562075838
          ],
          "filters_applied": null,
          "published_at_words": "27 minutes"
        }
      ],
      "components": [],
      "content_view_components": [],
      "activation_keys": [
        {
          "id": 568942081,
          "name": "Simple Activation Key"
        },
        {
          "id": 734311356,
          "name": "Another Simple Activation Key"
        },
        {
          "id": 323709460,
          "name": "Yet Another Activation Key"
        },
        {
          "id": 939253911,
          "name": "And Yet Another Simple Activation Key"
        },
        {
          "id": 757667888,
          "name": "Activation Key"
        }
      ],
      "hosts": [
        {
          "id": 980190962,
          "name": "host1.example.com"
        },
        {
          "id": 529902380,
          "name": "host4.example.com"
        }
      ],
      "next_version": "2.0",
      "last_published": "2024-05-23 19:46:01 UTC",
      "environments": [
        {
          "id": 562075838,
          "label": "library_label",
          "name": "Library",
          "activation_keys": [
            568942081,
            734311356,
            323709460,
            939253911,
            757667888
          ],
          "hosts": [
            980190962,
            529902380
          ],
          "permissions": {
            "readable": true
          }
        },
        {
          "id": 292811013,
          "label": "dev_label",
          "name": "Dev",
          "activation_keys": [],
          "hosts": [],
          "permissions": {
            "readable": true
          }
        }
      ]
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": true,
      "version_count": 0,
      "latest_version": null,
      "latest_version_id": null,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [],
      "id": 762379426,
      "name": "candlepin Default ContentView",
      "label": "candlepin_library_default_cv",
      "description": "A content view",
      "organization_id": 61304186,
      "organization": {
        "name": "Organization 2",
        "label": "Organization_2",
        "id": 61304186
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [],
      "repositories": [],
      "versions": [],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "1.0",
      "last_published": null,
      "environments": []
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 1,
      "latest_version": "1.0",
      "latest_version_id": 182230481,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [],
      "id": 566851579,
      "name": "Candlepin Library and Dev Content View",
      "label": "candlepin_library_dev_cv",
      "description": "A content view",
      "organization_id": 61304186,
      "organization": {
        "name": "Organization 2",
        "label": "Organization_2",
        "id": 61304186
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [
        {
          "id": 797271385,
          "name": "Candlepin Dev",
          "label": "candlepin_dev_label"
        }
      ],
      "repositories": [],
      "versions": [
        {
          "id": 182230481,
          "version": "1.0",
          "published": "2024-05-23 19:46:01 UTC",
          "description": null,
          "environment_ids": [
            797271385
          ],
          "filters_applied": null,
          "published_at_words": "27 minutes"
        }
      ],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "2.0",
      "last_published": "2024-05-23 19:46:01 UTC",
      "environments": [
        {
          "id": 797271385,
          "label": "candlepin_dev_label",
          "name": "Candlepin Dev",
          "activation_keys": [],
          "hosts": [],
          "permissions": {
            "readable": true
          }
        }
      ]
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 0,
      "latest_version": null,
      "latest_version_id": null,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [],
      "id": 1058174566,
      "name": "Candlepin Library Content View",
      "label": "candlepin_library_cv",
      "description": "A content view",
      "organization_id": 61304186,
      "organization": {
        "name": "Organization 2",
        "label": "Organization_2",
        "id": 61304186
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [],
      "repositories": [],
      "versions": [],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "2.0",
      "last_published": null,
      "environments": []
    },
    {
      "composite": true,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 1,
      "latest_version": "1.0",
      "latest_version_id": 323882142,
      "auto_publish": true,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [],
      "id": 64601712,
      "name": "Composite view",
      "label": "composite_view",
      "description": "A content view",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [
        {
          "id": 562075838,
          "name": "Library",
          "label": "library_label"
        }
      ],
      "repositories": [],
      "versions": [
        {
          "id": 323882142,
          "version": "1.0",
          "published": "2024-05-23 19:46:01 UTC",
          "description": null,
          "environment_ids": [
            562075838
          ],
          "filters_applied": null,
          "published_at_words": "27 minutes"
        }
      ],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "2.0",
      "last_published": "2024-05-23 19:46:01 UTC",
      "environments": [
        {
          "id": 562075838,
          "label": "library_label",
          "name": "Library",
          "activation_keys": [],
          "hosts": [],
          "permissions": {
            "readable": true
          }
        }
      ]
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 0,
      "latest_version": null,
      "latest_version_id": null,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": true,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [
        367202338
      ],
      "id": 951192321,
      "name": "Import-only content view",
      "label": "import_only_view",
      "description": "This CV may not be published except through CVV import",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [],
      "repositories": [
        {
          "id": 367202338,
          "name": "Fedora 17 x86_64",
          "label": "fedora_17_x86_64_label",
          "content_type": "yum"
        }
      ],
      "versions": [],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "2.0",
      "last_published": null,
      "environments": []
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 0,
      "latest_version": null,
      "latest_version_id": null,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "library_export",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [],
      "id": 462816975,
      "name": "library_export content view",
      "label": "library_export_view",
      "description": "This CV is generated for library export",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [],
      "repositories": [],
      "versions": [],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "2.0",
      "last_published": null,
      "environments": []
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 0,
      "latest_version": null,
      "latest_version_id": null,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "library_import",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [],
      "id": 72670789,
      "name": "library_import content view",
      "label": "library_import_view",
      "description": "This CV was generated for library import",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [],
      "repositories": [],
      "versions": [],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "2.0",
      "last_published": null,
      "environments": []
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 0,
      "latest_version": null,
      "latest_version_id": null,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [],
      "id": 282203774,
      "name": "No environment view",
      "label": "no_environment_view",
      "description": "A content view",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [],
      "repositories": [],
      "versions": [],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "1.0",
      "last_published": null,
      "environments": []
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 1,
      "latest_version": "1.0",
      "latest_version_id": 998596461,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": true,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [],
      "id": 451701987,
      "name": "No Filter Published LIbrary view",
      "label": "no_filter_published_library_view",
      "description": "A content view",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [],
      "repositories": [],
      "versions": [
        {
          "id": 998596461,
          "version": "1.0",
          "published": "2024-05-23 19:46:01 UTC",
          "description": null,
          "environment_ids": [],
          "filters_applied": null,
          "published_at_words": "27 minutes"
        }
      ],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "8.0",
      "last_published": "2024-05-23 19:46:01 UTC",
      "environments": []
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 1,
      "latest_version": "1.0",
      "latest_version_id": 172022917,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [],
      "id": 909058347,
      "name": "Published Library and dev view",
      "label": "published_dev_view",
      "description": "A content view",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [
        {
          "id": 562075838,
          "name": "Library",
          "label": "library_label"
        },
        {
          "id": 292811013,
          "name": "Dev",
          "label": "dev_label"
        },
        {
          "id": 292811013,
          "name": "Dev",
          "label": "dev_label"
        }
      ],
      "repositories": [],
      "versions": [
        {
          "id": 172022917,
          "version": "1.0",
          "published": "2024-05-23 19:46:01 UTC",
          "description": null,
          "environment_ids": [
            562075838,
            292811013,
            292811013
          ],
          "filters_applied": null,
          "published_at_words": "27 minutes"
        }
      ],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [
        {
          "id": 298486374,
          "name": "host2.example.com"
        }
      ],
      "next_version": "2.0",
      "last_published": "2024-05-23 19:46:01 UTC",
      "environments": [
        {
          "id": 562075838,
          "label": "library_label",
          "name": "Library",
          "activation_keys": [],
          "hosts": [],
          "permissions": {
            "readable": true
          }
        },
        {
          "id": 292811013,
          "label": "dev_label",
          "name": "Dev",
          "activation_keys": [],
          "hosts": [
            298486374
          ],
          "permissions": {
            "readable": true
          }
        }
      ]
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 1,
      "latest_version": "3.0",
      "latest_version_id": 234564707,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [],
      "id": 419082953,
      "name": "Published Library - dev - staging view",
      "label": "published_dev_staging_view",
      "description": "A content view",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [
        {
          "id": 562075838,
          "name": "Library",
          "label": "library_label"
        },
        {
          "id": 292811013,
          "name": "Dev",
          "label": "dev_label"
        },
        {
          "id": 1028819239,
          "name": "Staging",
          "label": "staging_label"
        }
      ],
      "repositories": [],
      "versions": [
        {
          "id": 234564707,
          "version": "3.0",
          "published": "2024-05-23 19:46:01 UTC",
          "description": null,
          "environment_ids": [
            562075838,
            292811013,
            1028819239
          ],
          "filters_applied": null,
          "published_at_words": "27 minutes"
        }
      ],
      "components": [],
      "content_view_components": [],
      "activation_keys": [
        {
          "id": 878475814,
          "name": "Lib Dev Stating Activation Key"
        }
      ],
      "hosts": [],
      "next_version": "4.0",
      "last_published": "2024-05-23 19:46:01 UTC",
      "environments": [
        {
          "id": 562075838,
          "label": "library_label",
          "name": "Library",
          "activation_keys": [],
          "hosts": [],
          "permissions": {
            "readable": true
          }
        },
        {
          "id": 292811013,
          "label": "dev_label",
          "name": "Dev",
          "activation_keys": [
            878475814
          ],
          "hosts": [],
          "permissions": {
            "readable": true
          }
        },
        {
          "id": 1028819239,
          "label": "staging_label",
          "name": "Staging",
          "activation_keys": [],
          "hosts": [],
          "permissions": {
            "readable": true
          }
        }
      ]
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 0,
      "latest_version": null,
      "latest_version_id": null,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [],
      "id": 615884193,
      "name": "Published Library no version",
      "label": "published_library_no_version",
      "description": "A content view",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [],
      "repositories": [],
      "versions": [],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "1.0",
      "last_published": null,
      "environments": []
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 2,
      "latest_version": "2.0",
      "latest_version_id": 111397700,
      "auto_publish": false,
      "solve_dependencies": false,
      "import_only": false,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": true,
      "repository_ids": [
        367202338,
        697316289
      ],
      "id": 405955044,
      "name": "Published LIbrary view",
      "label": "published_library_view",
      "description": "A content view",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [
        {
          "id": 562075838,
          "name": "Library",
          "label": "library_label"
        }
      ],
      "repositories": [
        {
          "id": 367202338,
          "name": "Fedora 17 x86_64",
          "label": "fedora_17_x86_64_label",
          "content_type": "yum"
        },
        {
          "id": 697316289,
          "name": "Debian 10 amd64",
          "label": "debian_10_amd64_label",
          "content_type": "deb"
        }
      ],
      "versions": [
        {
          "id": 531274492,
          "version": "1.0",
          "published": "2024-05-23 19:46:01 UTC",
          "description": "A nice content view version",
          "environment_ids": [],
          "filters_applied": null,
          "published_at_words": "27 minutes"
        },
        {
          "id": 111397700,
          "version": "2.0",
          "published": "2024-05-23 19:46:01 UTC",
          "description": "A nice content view version",
          "environment_ids": [
            562075838
          ],
          "filters_applied": null,
          "published_at_words": "27 minutes"
        }
      ],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "3.0",
      "last_published": "2024-05-23 19:46:01 UTC",
      "environments": [
        {
          "id": 562075838,
          "label": "library_label",
          "name": "Library",
          "activation_keys": [],
          "hosts": [],
          "permissions": {
            "readable": true
          }
        }
      ]
    },
    {
      "composite": false,
      "component_ids": [],
      "duplicate_repositories_to_publish": [],
      "default": false,
      "version_count": 1,
      "latest_version": "1.0",
      "latest_version_id": 436591151,
      "auto_publish": false,
      "solve_dependencies": true,
      "import_only": false,
      "generated_for": "none",
      "related_cv_count": 0,
      "related_composite_cvs": [],
      "filtered": false,
      "repository_ids": [
        367202338
      ],
      "id": 780068057,
      "name": "Solve Dependencies CV",
      "label": "solve_dependencies_cv",
      "description": "A content view",
      "organization_id": 114267492,
      "organization": {
        "name": "Empty Organization",
        "label": "Empty_Organization",
        "id": 114267492
      },
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "last_task": null,
      "latest_version_environments": [],
      "repositories": [
        {
          "id": 367202338,
          "name": "Fedora 17 x86_64",
          "label": "fedora_17_x86_64_label",
          "content_type": "yum"
        }
      ],
      "versions": [
        {
          "id": 436591151,
          "version": "1.0",
          "published": "2024-05-23 19:46:01 UTC",
          "description": null,
          "environment_ids": [],
          "filters_applied": null,
          "published_at_words": "27 minutes"
        }
      ],
      "components": [],
      "content_view_components": [],
      "activation_keys": [],
      "hosts": [],
      "next_version": "2.0",
      "last_published": "2024-05-23 19:46:01 UTC",
      "environments": []
    }
  ]
}

Params

Param name Description
organization_id
optional

organization identifier

Validations:

  • Must be a number.

environment_id
optional

environment identifier

Validations:

  • Must be a number.

nondefault
optional

Filter out default content views

Validations:

  • Must be one of: true, false, 1, 0.

noncomposite
optional

Filter out composite content views

Validations:

  • Must be one of: true, false, 1, 0.

composite
optional

Filter only composite content views

Validations:

  • Must be one of: true, false, 1, 0.

without
optional

Do not include this array of content views

Validations:

  • Must be an array of any type

name
optional

Name of the content view

Validations:

  • String

label
optional

Label of the content view

Validations:

  • String

include_generated
optional

Include content views generated by imports/exports. Defaults to false

Validations:

  • Must be one of: true, false, 1, 0.

search
optional

Search string

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return

Validations:

  • Must be a number.

order
optional

Sort field and order, eg. 'id DESC'

Validations:

  • String

full_result
optional

Whether or not to show all results

Validations:

  • Must be one of: true, false, 1, 0.

sort_by
optional

Field to sort the results on

Validations:

  • String

sort_order
optional

How to order the sorted results (e.g. ASC for ascending)

Validations:

  • String

Search fields

Field name Type Possible values
composite boolean
content_views string
default boolean
generated_for integer
label string
name string
organization_id integer