Search the Portal

Search the Portal

Returns results of a full-text search query. Projects/publications unavailable to the user sending request will be skipped. For unauthorized users, returns results from public publications only.

Query Parameters
  • q
    string
    required

    Full-text search query. May contain any supported search operators.

    Examplenebula
  • count
    integer

    The maximum number of results to return. When not specified, the top 10 results are returned. When a negative number is specified, returns all search results regardless of their total count.

    Example2
  • projectIds
    string

    Comma-separated list of project/publication IDs to search in. IDs of projects/publications you don't have access to will be ignored.

    Exampleproject-deep-space-exploration,space-program-pub
  • lang
    string

    Four-letter language code. If specified, only projects/publications in that language are searched.

    Exampleen-us
  • isReturnSnippets
    boolean

    If true, returns ftsTitle and ftsSnippet in the response body.

    Exampletrue
  • format
    string enum

    The format of the compiledContent field in the response. Possible values: html, md. Default: html.

    Examplehtml
    • html
    • md
Responses
GET/search
curl --location -g --request GET 'https://{portal-url}/api/v2/search?count=2&projectIds=project-deep-space-exploration,space-program-pub&lang=en-us&isReturnSnippets=true&q=nebula'


[
  {
    "assigneeUserName": "admin",
    "compiledContent": null,
    "compiledContentType": null,
    "createdOn": "2021-05-10T12:32:25",
    "ftsSnippet": "...A&#160;<strong>nebula</strong>&#160;( Latin&#160;for &#39;cloud&#39; or &#39;fog&#39;...) is an interstellar cloud&#160;of dust, hydrogen, helium&#160;and other ionized gases...",
    "ftsTitle": "New topic created with API",
    "fullUrl": "https://docs.hedron.org/articles/project-deep-space-exploration/nebula",
    "id": "nebula",
    "indexKeywords": [
      "cluster",
      "N",
      "nebula",
      "N, nebula"
    ],
    "modifiedOn": "2022-11-07T12:59:40",
    "ownerUserName": "admin",
    "projectId": "project-deep-space-exploration",
    "projectTitle": "Project Deep Space Exploration",
    "statusName": null,
    "title": "New topic created with API",
    "tocNodeId": "cd1ad87f-55a4-46e5-b496-c3434d555cd1",
    "isAutoTopic": false
  },
  {
    "assigneeUserName": "admin",
    "compiledContent": null,
    "compiledContentType": null,
    "createdOn": "2022-10-25T13:32:19",
    "ftsSnippet": "...A&#160;<strong>nebula</strong>&#160;( Latin&#160;for &#39;cloud&#39; or &#39;fog&#39;...) is an interstellar cloud&#160;of dust, hydrogen, helium&#160;and other ionized gases...",
    "ftsTitle": "<strong>Nebula</strong>",
    "fullUrl": "https://docs.hedron.org/articles/space-program-pub/nebula",
    "id": "nebula",
    "indexKeywords": [],
    "modifiedOn": "2022-10-25T13:32:27",
    "ownerUserName": "admin",
    "projectId": "space-program-pub",
    "projectTitle": "Space Program Pub",
    "statusName": null,
    "title": "Nebula",
    "tocNodeId": "cd1ad87f-55a4-46e5-b496-c3434d555cd1",
    "isAutoTopic": false
  }
]

OK