Skip to main content
GET
Retrieve

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

body
object | null

The JSON request body for this operation.

http_method
string

The HTTP method for this operation – one of DELETE, GET, PATCH, POST, or PUT.

path
string

The API path for this operation. Must start with / and contain only valid URL characters.

query_params
object | null

The query parameters for this operation.

response_body
object | null

The JSON response body returned by this operation.

response_status
integer | null

The HTTP response status code returned by this operation.

status
string

The status of this operation. Possible values include:

  • completed: The operation was executed and a response was received.
  • failed: The operation encountered an internal error and could not be executed.
  • in_progress: The operation is currently being executed.
  • pending: The operation has not yet started execution.
  • timed_out: The operation exceeded the allowed execution time.
batch

The batch this operation belongs to.

Expandable – The associated batch ID.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.