List all documents from a group
Fetches all documents of a given groupUse URL params to control or filter the result:- ?search=wordto only show documents that contain word- ?offset=0&limit=10 to have a paginated view- ?details=segments,meta,tags to show details of a document segments: Show segments of a document tags: Show tags of a document * meta: Show all the additional attributes that were originally given as the document was uploaded
Path Parameters
- project_id integer required
ID of the project
- group_id integer required
ID of the document group
Query Parameters
- search string
Search by name
- details string
Possible values: [
segments
,meta
,tags
]Which documents' details API should return. Values might be any combination of 'segments', 'meta' and 'tags'.
- offset integer
An offset is simply the number of records you wish to skip before selecting records.
- limit integer
Limit of entries that should be returned.
- 200
- 401
- 403
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema array
- text string
The document text
segments object[]
list of segments
text stringThe segment text
span integer[]The interval at which the segment occurs in the original document
tags object[]
A list of tags
class stringThe class's name.
label stringThe label's name.
[
{
"text": "Document 1",
"segments": [
{
"text": "Segment 1",
"span": [
0,
9
],
"tags": [
{
"class": "Comfort",
"label": "POS"
}
]
}
]
}
]
User is not authenticated. This means token is either not present or invalid
User does not have the minimal required project role "VIEWER"
The group or the project was not found
Something is wrong with the API.