Skip to main content
GET
List form batches

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

owner_id
string

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

owner_type
enum<string>

Filter form batches based on the type of owner.

Available options:
business_entity
form_type

Filter form batches based on the form type.

Available options:
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
form_stage

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

Available options:
amendment,
cancellation,
original
status

Filter form batches based on the status.

Available options:
done,
draft,
processing,
submitted
sort
enum<string>

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).

Available options:
effective_date
expand
enum<string>[]
Available options:
owner

Response

200 - application/json

OK

object
string
read-only

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

data
object[]