Skip to main content
GET
Get Task Status

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

The unique identifier of the search to retrieve the status for.

Examples:

"412a49b5-7466-426b-bf1e-081b00b54576"

"9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5"

Response

Successful Response

Represents a business search status response.

id
string<uuid>
required

Unique identifier for the business search.

state
enum<string>
required

The current state of the business search.

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
Example:

"COMPLETED"

console_url
string<uri>
required

The URL to the business search details in the console.

Required string length: 1 - 2083
Example:

"https://console.baselayer.com/search/c06777fe-1f7e-11ef-af7e-1edb1b067314"

error
string | null

Any errors that occurred.

Example:

"RuntimeError The Business Search could not be completed."

warnings
string[]

Any warnings that occurred.

Example:
business_url
string<uri> | null

The API URL to retrieve the business details.

Required string length: 1 - 2083
Example:

"https://api.baselayer.com/businesses/ae752082-1f7e-11ef-b572-1edb1b067314"