extract

GET /api/v1/extract/parties/

Party List

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/extract/parties/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"

Response

pkinteger

namestring required

typestring nullable

type_abbrstring nullable required

type_labelstring nullable

type_descriptionstring nullable

descriptionstring nullable

Example response

[
  {
    "name": "name",
    "description": "description",
    "type_abbr": "type_abbr",
    "pk": 0,
    "type_label": "type_label",
    "type": "type",
    "type_description": "type_description"
  }
]

Changes

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