Get queued request by ID

curl --request GET \
  --url https://qubesync.com/api/v1/queued_requests/{request_id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "state": "response_received",
    "webhook_state": "succeeded",
    "request_xml": "<QBXML><QBXMLMsgsRq onError='stopOnError'><CustomerQueryRq requestID='1'><MaxReturned>1</MaxReturned></CustomerQueryRq></QBXMLMsgsRq></QBXML>",
    "response_xml": "<QBXML><QBXMLMsgsRs statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerQueryRs requestID='1' statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerRet><ListID>80000001-1234567890</ListID><Name>Sample Customer</Name></CustomerRet></CustomerQueryRs></QBXMLMsgsRs></QBXML>",
    "webhook_url": "https://example.com/webhooks/qube_sync",
    "webhook_attempts": [
      {
        "attempted_at": "2023-01-01T12:00:05Z",
        "response": "success"
      }
    ],
    "links": {
      "self": "/api/v1/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "ui": "/app/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "connection_ui": "/app/connections/123e4567-e89b-12d3-a456-426614174000"
    },
    "inserted_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:00:05Z"
  }
}

GET

queued_requests

{request_id}

Get queued request by ID

curl --request GET \
  --url https://qubesync.com/api/v1/queued_requests/{request_id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "state": "response_received",
    "webhook_state": "succeeded",
    "request_xml": "<QBXML><QBXMLMsgsRq onError='stopOnError'><CustomerQueryRq requestID='1'><MaxReturned>1</MaxReturned></CustomerQueryRq></QBXMLMsgsRq></QBXML>",
    "response_xml": "<QBXML><QBXMLMsgsRs statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerQueryRs requestID='1' statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerRet><ListID>80000001-1234567890</ListID><Name>Sample Customer</Name></CustomerRet></CustomerQueryRs></QBXMLMsgsRs></QBXML>",
    "webhook_url": "https://example.com/webhooks/qube_sync",
    "webhook_attempts": [
      {
        "attempted_at": "2023-01-01T12:00:05Z",
        "response": "success"
      }
    ],
    "links": {
      "self": "/api/v1/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "ui": "/app/queued_requests/550e8400-e29b-41d4-a716-446655440000",
      "connection_ui": "/app/connections/123e4567-e89b-12d3-a456-426614174000"
    },
    "inserted_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:00:05Z"
  }
}

Authorizations

Authorization

string

header

required

Use your app's API_KEY as the username, and leave the password blank

Path Parameters

request_id

string<uuid>

required

The unique identifier of the queued request

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Queued request found and returned successfully

data

object

Show child attributes

data.id

string<uuid>

required

Unique identifier for the queued request

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.state

enum<string>

required

Current state of the queued request

Available options:

waiting,

retryable,

ticketed,

sent,

response_received,

error,

discarded

data.request_xml

string

required

The QBXML request to be processed

Example:

"<QBXML><QBXMLMsgsRq onError='stopOnError'><CustomerQueryRq requestID='1'><MaxReturned>100</MaxReturned></CustomerQueryRq></QBXMLMsgsRq></QBXML>"

data.connection_id

string<uuid>

required

ID of the connection this request belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.webhook_state

enum<string>

State of the webhook delivery. Not applicable if webhook_url was not provided.

Available options:

not_applicable,

pending,

succeeded,

failed

data.request_json

object

The request payload in JSON format (alternative to request_xml)

Example:

{
  "version": "13.0",
  "request": {
    "name": "CustomerQueryRq",
    "attributes": { "request_id": "1" },
    "children": [{ "name": "MaxReturned", "text": "100" }]
  }
}

data.response_xml

string | null

The QBXML response from QuickBooks

Example:

"<QBXML><QBXMLMsgsRs statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerQueryRs requestID='1' statusCode='0' statusSeverity='Info' statusMessage='Status OK'><CustomerRet><ListID>80000001-1234567890</ListID><Name>Sample Customer</Name></CustomerRet></CustomerQueryRs></QBXMLMsgsRs></QBXML>"

data.response_json

object[] | null

The response payload in JSON format, if request is completed

data.webhook_url

string<uri> | null

URL to receive a webhook when the request is completed

Example:

"https://example.com/webhook"

data.webhook_attempts

object[]

List of webhook delivery attempts with timestamps and responses

Show child attributes

data.webhook_attempts.attempted_at

string<date-time>

required

The timestamp when the webhook was attempted

data.webhook_attempts.response

string

required

The response from the webhook endpoint or an error message

data.webhook_error

string | null

Error message if webhook delivery failed

data.error

object

Error details if the request failed processing

Show child attributes

data.error.message

string

data.error.code

string

data.error.details

object

data.links

object

Show child attributes

data.links.self

string<uri>

required

Example:

"/api/v1/connections/123e4567-e89b-12d3-a456-426614174000/queued_requests/550e8400-e29b-41d4-a716-446655440000"

data.links.ui

string<uri>

required

Example:

"/app/queued_requests/550e8400-e29b-41d4-a716-446655440000"

data.links.connection_ui

string<uri>

required

Example:

"/app/connections/123e4567-e89b-12d3-a456-426614174000"

data.inserted_at

string<date-time>

When the request was created

Example:

"2023-01-01T12:00:00Z"

data.updated_at

string<date-time>

When the request was last updated

Example:

"2023-01-01T12:00:01Z"

Queue a new request Delete a queued request

⌘I

QuBe Sync API

API Documentation

Get queued request by ID

Authorizations

Path Parameters

Response