Skip to main content
GET
Retrieve fields

Authorizations

Authorization
string
header
required

Bearer token issued via the Authentication endpoints.

Headers

Authorization
string
required

A bearer authorization header containing a Risk Cloud API access token in the format Authorization: Bearer TOKEN — replace TOKEN with your actual access token.

To obtain a Risk Cloud API access token, refer to Obtain an API Access Token in the LogicGate Help Center.

Query Parameters

application-id
string
default:""

The unique ID of an application where, if provided, the response will only contain fields from the identified application

workflow-id
string
default:""

The unique ID of a workflow where, if provided, the response will only contain fields from the identified workflow

step-id
string
default:""

The unique ID of a step where, if provided, the response will only contain fields from the identified step

field-type
enum<string>[]

A field type where, if provided, the response will only contain fields of the identified field type

Available options:
DATE,
USER,
EXTERNAL_USER,
TEXT,
TEXT_AREA,
NUMBER,
E_SIGNATURE,
CHECKBOX,
MULTI_SELECT,
RADIO,
SELECT,
ATTACHMENT,
CALCULATION,
TEXT_CONCATENATION,
DATE_CALCULATION
scope
enum<string>
default:ALL

A scope where, if provided, the response will only contain fields that have either global or workflow scopes (defaults to ALL)

Available options:
ALL,
GLOBAL,
WORKFLOW
page
integer<int32>

The zero-indexed page number (must not be less than 0, defaults to 0)

Required range: x >= 0
size
integer<int32>

The size of the page and maximum number of items to be returned (must not be less than 1, defaults to 20)

Required range: x >= 1

Response

200 - application/json

OK

content
Field (Response) · object[]

A array of returned items

A collection of page URL links for navigation and iteration

page
Page Info · object

A collection page metadata