FruxonDocs
ApiKnowledge bases

Lists a knowledge base's notices, newest posted first.

Active notices by default. Each carries whether agents are given it now (`active`), when it stopped or will stop (`endedAt`), who posted and withdrew it, and its history of edits (`events`).

GET
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/notices

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

knowledgeBase*string

The knowledge base id.

Formatuuid
tenant*string

The tenant identifier

Query Parameters

PageSize?integer

The maximum number of items to return per page

Formatint32
PageToken.Skip?integer
Formatint32
PageToken.Cursor?string

Opaque pagination token returned by an external service. Pass it back unchanged rather than interpreting it as an offset.

state?string

ACTIVE (the default), ENDED (withdrawn or past their end), or ALL.

Value in"UNSPECIFIED" | "ACTIVE" | "ENDED" | "ALL"

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/notices"
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "knowledgeBaseId": "00000000-0000-0000-0000-000000000000",
      "title": "string",
      "body": "string",
      "validUntil": 0,
      "timeZone": "string",
      "active": false,
      "endedAt": 0,
      "createdAt": 0,
      "createdBy": "string",
      "modifiedAt": 0,
      "modifiedBy": "string",
      "withdrawnAt": 0,
      "withdrawnBy": "string",
      "withdrawNote": "string",
      "reactivatesId": "00000000-0000-0000-0000-000000000000",
      "source": "UI",
      "sourceDetail": "string",
      "events": []
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}