Details of form field

get

https://core.nextmatter.com/api/processes/{process_id}/steps/{step_id}/actions/{action_id}/

Show details of a form field including all instances the field it is used in.

Page size is 100 by default, 500 maximum. To paginate, follow the standard usage of limit and page parameters.

We strongly recommend using filters with this endpoint and limiting the number of results, especially when requests are frequent. Otherwise, performance might degrade.

Path Params

process_id

string

required

step_id

string

required

action_id

string

required

Query Params

organization

string

organization

process

string

process

lead_user

string

lead_user

progress

string

progress

string

ordering

string

enum

Ordering

status

string

enum

status

Allowed:

name

string

name

query

string

query

priority

string

enum

priority

Allowed:

started_time

string

started_time

last_updated_time

string

last_updated_time

deadline

string

deadline

step_deadline

string

step_deadline

aborted_time

string

aborted_time

completed_time

string

completed_time

ended_time

string

ended_time

total_runtime_min

string

total_runtime_min

total_runtime_max

string

total_runtime_max

active_step_id

string

active_step_id

tags

instance_ids

string

instance_ids

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200