List knowledge records

get

https://api.platform.briink.com/workspaces/{workspace_id}/knowledge

Returns a list of knowledge records for a workspace. Supports optional pagination and sorting via offset, limit, sort_by, sort_order, optional is/is_not filters (company_id, verification_status, source_type, expiry), and an inclusive validity-overlap window (valid_from, valid_to).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workspace_id

uuid

required

Query Params

archived

boolean

Defaults to false

company_id

Filter by company (entity) id

company_id_op

string

enum

Defaults to is

Operator for company_id: is or is_not

Allowed:

verification_status

KnowledgeRecordStatusEnum | null

Filter by verification status

verification_status_op

string

enum

Defaults to is

Operator for verification_status: is or is_not

Allowed:

source_type

KnowledgeRecordSourceEnum | null

Filter by source type

source_type_op

string

enum

Defaults to is

Operator for source_type: is or is_not

Allowed:

expiry

KnowledgeExpiryPresetEnum | null

Filter by expiry: expired or no_expiry

expiry_op

string

enum

Defaults to is

Operator for expiry: is or is_not

Allowed:

valid_from

null

Filter to records valid on or after this inclusive boundary. ISO datetime inputs are accepted, but the time and timezone are discarded.

valid_to

null

Filter to records valid on or before this inclusive boundary. ISO datetime inputs are accepted, but the time and timezone are discarded.

offset

≥ 0

Number of items to skip before returning results

limit

1 to 100

Maximum number of items to return (1-100)

sort_by

string

enum

Resource-specific sort column

Allowed:

sort_order

SortOrder | null

Sort direction: ascending or descending

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error