Search for annotations
search_annotations(
limit = 20L,
sort = c("updated", "created", "group", "id", "user"),
search_after = NULL,
offset = 0,
order = c("desc", "asc"),
uri = NULL,
uri.parts = NULL,
wildcard_uri = NULL,
user = NULL,
group = NULL,
tags = NULL,
any = NULL,
quote = NULL,
references = NULL,
text = NULL,
api_path = get_hs_host(),
api_key = NULL
)The maximum number of annotations to return.
Available values : updated, created, group, id, user, Default: `updated`
Define a start point for a subset (page) of annotation search results. Example: 2023-01-01T10:00:00.000000+00:00
The number of initial annotations to skip in the result set.
The order in which the results should be sorted. Default: `desc`
Limit the results to annotations matching the specific URI or equivalent URIs. URI can be a URL (a web page address) or a URN representing another kind of resource such as DOI (Digital Object Identifier) or a PDF fingerprint.
Limit the results to annotations containing the given keyword (tokenized chunk) in the URI.
Limit the results to annotations whose URIs match the wildcard pattern.
Limit the results to annotations made by the specified user. Example: `user=acct:username@hypothes.is`
Limit the results to annotations made in the specified group (by group ID).
Limit the results to annotations tagged with the specified value. Example: tags=artificial,intelligence
Limit the results to annotations who contain the indicated keyword in any of the following field: `quote, tags, text, url`
Limit the results to annotations that contain this text inside the text that was annotated.
Returns annotations that are replies to this parent annotation ID.
Limit the results to annotations that contain this text in their textual body.
The hypothesis API path, can be specify by `hypothesis.api.api_path` option or `HYPOTHESIS_API_PATH` environment variable. Default: `https://hypothes.is/api/`.
User api key, generated on the platform.