GET /api/v1/sponsorships/{id}
Parameters
| Name | Location | Details |
|---|---|---|
X-Juicebox-Account | header / required | Enrolled account identity, including authority chain and lowercase owner address. Enrollment derives this identity before the account exists. |
X-Juicebox-Signer | header / required | Owner wallet or authorized bot address that signed this request. |
X-Juicebox-Issued-At | header / required | Unix seconds, sent as 1–13 decimal digits without leading zeros; at most 30 seconds ahead of server time. |
X-Juicebox-Expires-At | header / required | Unix seconds, sent as 1–13 decimal digits without leading zeros; in the future and within 300 seconds of issuedAt. |
X-Juicebox-Nonce | header / required | Fresh random 32-byte lowercase nonce. A consumed nonce cannot be retried. |
X-Juicebox-Signature | header / required | EIP-712 CenterRequest signature over every signed field. Contract-owner signatures may vary in length. This is a computed request proof, not a reusable API key. |
X-Juicebox-Grant | header / optional | Authorized bot grant ID. Required for a bot; omit for the owner, signing grantId as the empty string. |
Idempotency-Key | header / optional | Signed retry identity. Required on plan creation and transaction submission. Preserve exact method, target, Content-Type, and body bytes; use a fresh request nonce and signature. |
id | path / required | string |
refresh | query / optional | boolean |
Response 200
| Field | Type | Details | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string (uuid) required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
planId | string (uuid) required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
planCommitment | string required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commitment | string required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string required | Values: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
availability | string required | funding_quote_available does not establish that the bundle is unpaid. execution_verified confirms exact inner execution; completed additionally requires verified modeled economic semantics. Values: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdAt | integer required | Unix timestamp in milliseconds. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
publicationExpiresAt | integer required | Original source-plan cutoff for new publication. It cannot revoke a ForwardRequest already published. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
revision | integer required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
authorizations | array required | Fields
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
submission | object optional | Fields
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
quote | object optional | Fields
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
observations | array required | Fields
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
authorizationNotice | string required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fundingNotice | string required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
recovery | string optional | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
economicCompletion | boolean required |
JSON schema
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/ResourceId"
},
"planId": {
"$ref": "#/components/schemas/ResourceId"
},
"planCommitment": {
"$ref": "#/components/schemas/Hash"
},
"commitment": {
"$ref": "#/components/schemas/Hash"
},
"state": {
"type": "string",
"enum": [
"prepared",
"submitting",
"submission_unknown",
"quoted"
]
},
"availability": {
"type": "string",
"enum": [
"available",
"submission_unknown",
"requires_verification",
"funding_quote_available",
"execution_verified",
"completed"
],
"description": "funding_quote_available does not establish that the bundle is unpaid. execution_verified confirms exact inner execution; completed additionally requires verified modeled economic semantics."
},
"createdAt": {
"$ref": "#/components/schemas/UnixMilliseconds"
},
"publicationExpiresAt": {
"$ref": "#/components/schemas/UnixMilliseconds",
"description": "Original source-plan cutoff for new publication. It cannot revoke a ForwardRequest already published."
},
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"authorizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForwardAuthorization"
},
"minItems": 1,
"maxItems": 32
},
"submission": {
"type": "object",
"properties": {
"hash": {
"$ref": "#/components/schemas/Hash"
},
"startedAt": {
"$ref": "#/components/schemas/UnixMilliseconds"
},
"repeatPublicationAllowed": {
"type": "boolean",
"const": false
}
},
"required": [
"hash",
"startedAt",
"repeatPublicationAllowed"
],
"additionalProperties": false
},
"quote": {
"type": "object",
"properties": {
"bundleUuid": {
"type": "string"
},
"commitment": {
"$ref": "#/components/schemas/Hash"
},
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SponsorshipPayment"
},
"maxItems": 4
},
"runtimeVerified": {
"type": "boolean"
},
"observedAt": {
"$ref": "#/components/schemas/UnixMilliseconds"
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"txUuid": {
"type": "string"
},
"chainId": {
"type": "integer",
"enum": [
1,
10,
8453,
42161
]
},
"outerCallHash": {
"$ref": "#/components/schemas/Hash"
}
},
"required": [
"txUuid",
"chainId",
"outerCallHash"
],
"additionalProperties": false
},
"maxItems": 32
}
},
"required": [
"bundleUuid",
"commitment",
"payments",
"runtimeVerified",
"observedAt",
"transactions"
],
"additionalProperties": false
},
"observations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SponsorshipObservation"
},
"maxItems": 32
},
"authorizationNotice": {
"type": "string"
},
"fundingNotice": {
"type": "string"
},
"recovery": {
"type": "string"
},
"economicCompletion": {
"type": "boolean"
}
},
"required": [
"id",
"planId",
"planCommitment",
"commitment",
"state",
"availability",
"createdAt",
"publicationExpiresAt",
"revision",
"authorizations",
"observations",
"authorizationNotice",
"fundingNotice",
"economicCompletion"
],
"additionalProperties": false
}