Skip to main content
GET
ListContextEntries

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pagination.cursor
string

Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.

pagination.pageSize
integer<int32>

Maximum number of items to return in a single page. If not provided, defaults vary per API.

Required range: x >= 0
kinds
enum<string>[]

Only entries of these kinds. Empty means every kind.

The kind of a context entry. The kind decides where a person sees the entry in the app. It does not decide who reads it: people and agents read every kind.

Available options:
CONTEXT_ENTRY_KIND_UNSPECIFIED,
CONTEXT_ENTRY_KIND_ANNOUNCEMENT,
CONTEXT_ENTRY_KIND_DESCRIPTION,
CONTEXT_ENTRY_KIND_GUIDANCE
authorUserIds
string[]

Only entries created by these users, by the id of a user from synq.users.v1.UsersService. Empty means every author.

Maximum array length: 100
Required string length: 1 - 200
targetEntityId
string

Only entries that target this one entity. Entries with a query are left out. To find every entry that applies to an entity, use BatchGetEntityContextEntries.

Required string length: 1 - 1000

Response

200 - application/json

Success

entries
ContextEntry · object[]

The matching entries.

pageInfo
PageInfo · object

Pagination cursor for the next page.