Search document

GET
Search Archbee documents in docSpace
AUTHENTICATION
Authorization
Bearer
Bearer
HEADER PARAMETERS
Content-Type
string
*
Example: application/json
BODY PARAMETERS
body
object
*
apiKey
string
*
Example: 21-character__string0
ApiKey id of the docSpace.
docSpaceId
string
*
Example: 21-character__string0
DocSpace id used for search.
query
string
*
Filter text
searchOnlyTitle
boolean
OPTIONAL: Search only by title
RESPONSES
200
Process status
object
Process status
status
string<OK>
Response Status
data
object
Example: [object Object]
Response Data
400
Invalid request
Response400
status
string<OK | Not OK>
Response Status
messages
string[]
Example: 
Array of messages
Curl
JS
Ruby
Python
|
curl --location --request GET 'https://app.archbee.com/api/public-api/docs/search' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
  "apiKey": "",
  "docSpaceId": "",
  "query": "",
  "searchOnlyTitle": false
}'
curl --location --request GET 'https://app.archbee.com/api/public-api/docs/search' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
  "apiKey": "",
  "docSpaceId": "",
  "query": "",
  "searchOnlyTitle": false
}'
RESPONSES
200
400
|
// Process status 
{
  "status": "",
  "data": {
    "searchSessionId": "",
    "docs": [
      ""
    ]
  }
}
// Process status 
{
  "status": "",
  "data": {
    "searchSessionId": "",
    "docs": [
      ""
    ]
  }
}
﻿
﻿
Updated 22 Sep 2023
Did this page help you?
Delete document
Organizations
Docs powered by
Archbee