Skip to main content
GET
/
public
/
v1
/
knowledge-base
/
groups
List groups
curl --request GET \
  --url https://api.callin.io/api/public/v1/knowledge-base/groups \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": [
    {
      "groupId": "<string>",
      "name": "<string>",
      "documents": [
        {
          "documentId": "<string>",
          "type": "url",
          "name": "<string>",
          "details": {
            "url": "<string>"
          },
          "metadata": {
            "createdAt": "2023-11-07T05:31:56Z",
            "createdBy": {
              "userId": "<string>",
              "userEmail": "<string>"
            }
          }
        }
      ],
      "metadata": {
        "createdAt": "2023-11-07T05:31:56Z",
        "createdBy": {
          "userId": "<string>",
          "userEmail": "<string>"
        }
      }
    }
  ],
  "pagination": {
    "pageSize": 123,
    "hasMore": true,
    "nextCursor": "<string>",
    "sortBy": "name",
    "sortDirection": "asc"
  }
}

Authorizations

x-api-key
string
header
required

Send your Callin API key in the x-api-key header.

Query Parameters

cursor
string

Used for fetching next page. Cursor is returned in the response.

pageSize
integer
default:30

How many groups to return at maximum. Can not exceed 100, defaults to 30.

Required range: 1 <= x <= 100

Search for groups by name

sortBy
enum<string>

The field to sort the results by

Available options:
name,
created_at
sortDirection
enum<string>

The direction to sort the results

Available options:
asc,
desc

Response

Groups list

Paginated knowledge groups.

success
boolean
Example:

true

data
object[]

A list of groups and their metadata

pagination
object