BizKitHub Developer Documentation

Parameters

2 query

Query parameters

· 2

beforestringOptional

Exampleexample_before

limitstringOptional

Exampleexample_limit

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

externalIdstringRequired

Length: 16–16

authorKind"member" | "system" | "bot" | "agent"Required

authorMemberIdstring | integer | nullRequired

One of 2:

Variant 1

string | integer

One of 2:

Variant 1

stringinteger

Default: 0

Variant 2

integer

Variant 2

null

authorContactExternalIdstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

authorMemberLabelstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

systemAuthorLabelstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

authorAvatarInfoobjectRequired

fullNamestringOptional

avatarUrlstringOptional

activityInfoobjectOptional

statusstringOptional

inActiveMinutesnumberOptional

lastActivitystring | Date | string | string | numberOptional

One of 2:

Variant 1

string

Variant 2

Date | string | string | number

One of 4:

Variant 1

Date

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

bodyMarkdownstringRequired

metaobject | nullRequired

One of 2:

Variant 1

object

Variant 2

null

insertedDatestringRequired

updatedDatestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

lastActivityAtstringRequired

pinnedAtstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

reactorsobjectRequired

commentCountstring | integerRequired

One of 2:

Variant 1

stringinteger

Default: 0

Variant 2

integer

attachmentsobject[]Required

Each array item:

blobTokenstringRequired

Length: 32–32

filenamestringRequired

contentTypestringRequired

sizestring | integerRequired

One of 2:

Variant 1

stringinteger

Default: 0

Variant 2

integer

canManagebooleanRequired

canPinbooleanRequired

latestCommentobject | nullRequired

One of 2:

Variant 1

externalIdstringRequired

Length: 16–16

authorKind"member" | "system" | "bot" | "agent"Required

authorMemberIdstring | integer | nullRequired

One of 2:

Variant 1

string | integer

One of 2:

Variant 1

stringinteger

Default: 0

Variant 2

integer

Variant 2

null

authorContactExternalIdstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

authorLabelstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

authorAvatarInfoobjectRequired

fullNamestringOptional

avatarUrlstringOptional

activityInfoobjectOptional

statusstringOptional

inActiveMinutesnumberOptional

lastActivitystring | Date | string | string | numberOptional

One of 2:

Variant 1

string

Variant 2

Date | string | string | number

One of 4:

Variant 1

Date

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

bodyMarkdownstringRequired

insertedDatestringRequired

updatedDatestring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

Variant 2

null

hasMorebooleanRequired

Response example

application/json

{
  "items": [
    {
      "externalId": "example_externalId",
      "authorAvatarInfo": {
        "fullName": "example_fullName",
        "avatarUrl": "example_avatarUrl",
        "activityInfo": {
          "status": "example_status",
          "inActiveMinutes": 0
        }
      },
      "bodyMarkdown": "example_bodyMarkdown",
      "insertedDate": "example_insertedDate",
      "lastActivityAt": "example_lastActivityAt",
      "reactors": {},
      "attachments": [
        {
          "blobToken": "example_blobToken",
          "filename": "example_filename",
          "contentType": "example_contentType"
        }
      ],
      "canManage": false,
      "canPin": false
    }
  ],
  "hasMore": false
}

/bff/feed/stream

Parameters

Query parameters

Response schema

Response example

Request example

Need an API key?