Sign in

v4

OpenAPI 3.0.02026-07-314441026.8 MB
Form Batches

List form batches

get/form_batches

Query parameters

owner_idstring

Filter form batches based on the owner. Accepts multiple comma-separated values.

owner_type'business_entity'

Filter form batches based on the type of owner.

'rl1' | 'roe' | 't4' | 't4a' | 'td1' | 'td1ab' | 'td1bc' | 'td1mb' | 'td1nb' | 'td1nl' | 'td1ns' | 'td1nt' | 'td1nu' | 'td1on' | 'td1pe' | 'td1sk' | 'td1x' | 'td1yt' | 'tp_1015_3_v' | 'tp_1015_r_13_v'
OR
string[]

Filter form batches based on the form type.

'amendment' | 'cancellation' | 'original'
OR
string[]

Filter form batches based on the stage (original, amendment, cancellation).

'done' | 'draft' | 'processing' | 'submitted'
OR
string[]

Filter form batches based on the status.

sort'effective_date'

Sort order is specified using the format sort=field[:direction][,field[:direction],...] where field is the name of the field to sort by and direction is the optional sort direction (asc or desc).

expandstring[]

Response

OK

objectstring

The type of the object in Nmbr ("list").