Skip to main content
A parser is the field schema your tenant uses for a vertical: the list of fields a mission or event of that vertical carries, with their type, size and protection rules. Each vertical can have several numbered versions; the active parser of a vertical is its highest active version.

Authentication

Session token (Authorization: Bearer <token>) with the parsers:read permission. Tenant roles with it: company_admin, company_tech, operational_supervisor, corporate_client. Parsers are tenant content: wede staff roles do not have parsers:read and cannot read them.
The integration API key (x-wede-api-key) has no parsers:* permission. Calls with an API key return 403 forbidden.

The parser object

string
Parser UUID.
string
Your tenant.
string
Vertical code, for example healthcare.
integer
Version number within the vertical, starting at 1.
string
Display name.
string | null
Description.
boolean
Whether this version is active.
object[]
Field definitions. See Create a parser.
string | null
UUID of the user who created it.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.

List parsers

Returns every parser version of your tenant, ordered by vertical and then by version, newest first.
Response 200

Get a parser

string
required
Parser UUID.
Returns the parser object.

Get the active parser of a vertical

string
required
Vertical code.
Returns the highest active version for the vertical.

Errors

SDKs

listParsers, getParser and getActiveParser in JavaScript; list_parsers, get_parser and get_active_parser in Python.