document

GET /api/v1/document/documents/

Document List with Fields

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/document/documents/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

jq_filtersobject

Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"

cluster_idinteger

Cluster id to filter by

qstring

Search parameters for djangoQL

Response

pkinteger

namestring nullable

document_typestring nullable

projectinteger nullable

status_namestring required

Example response

[
  {
    "status_name": "status_name",
    "name": "name",
    "project": 6,
    "pk": 0,
    "document_type": "document_type"
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.