Skip to main content
GET
Get All Docket Searches

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer
default:10

The maximum number of docket searches to return.

Required range: x >= 1
offset
integer
default:0

The number of docket searches to skip before starting to return the docket searches.

Required range: x >= 0
type
enum<string>

The type of docket searches to return.

Available options:
Business,
Person,
BusinessSearch
Examples:

"Business"

"Person"

"BusinessSearch"

Response

Successful Response

id
string<uuid>
required

The identifier of this docket search request.

state
enum<string>
required

The current state of the docket search request.

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
business_id
string<uuid> | null

The identifier of the business the search was performed for.

person_id
string<uuid> | null

The identifier of the person the search was performed for.

business_search_id
string<uuid> | null

The identifier of the business search the docket search was performed for