Skip to main content
GET
/
v1
/
community
/
search
/
articles
Search articles
curl --request GET \
  --url https://api1.irisagent.com/v1/community/search/articles \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Business-Id: <x-business-id>'
{
  "articles": [
    {
      "id": "<string>",
      "title": "<string>",
      "url": "<string>",
      "snippet": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The Authorization header is required to authenticate API requests. It should contain a bearer token obtained through the IrisAgent portal.

Headers

​
X-Business-Id
string
required

Business ID of the customer.

Query Parameters

​
text
string
required

The search query string.

​
offset
integer<uint>

Pagination offset for search results.

Required range: x >= 0
​
limit
integer<uint>
default:25

Maximum number of results to return.

Required range: x >= 1

Response

Search results

​
articles
object[]
required