Skip to main content
POST
ListEntitiesWithMark

Authorizations

Authorization
string
header
required

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

Body

application/json
kind
enum<string>

The kind of mark that the entities carry.

Available options:
MARK_KIND_UNSPECIFIED,
MARK_KIND_CERTIFIED,
MARK_KIND_DEPRECATED
setByIdentities
string[]

Identity strings of the person, to keep only the entities whose mark the person set. Resolve a user to all their identities with synq.users.v1.UsersService GetUserIdentities first. Format: "synq:<user_id>", "email:", "slack:<slack_user_id>". Empty keeps every person. The deprecation query names no person, so with a person set, the entities that only the query deprecates are not listed.

Maximum array length: 100
Required string length: 1 - 1024
limitToEntityIds
string[]

Opaque ids of entities, to keep only these. An entity matches when its identity group carries the mark. Empty keeps every entity of the workspace. To check more than 10000 entities, split them over several requests.

Maximum array length: 10000
Required string length: 1 - 1024
pagination
Pagination · object | null

The page to read, in the order of the entity id. Without it, the response has every entity. With it, the default page size is 100, and the largest is 1000.

Response

200 - application/json

Success

entities
EntityWithMark · object[]

The entities, sorted by entity id.

pageInfo
PageInfo · object

last_id is the cursor of the next page, empty on the last page.