Poll a claim for its current state

How a caller without a persistent connection learns its queued claim was granted. position is advisory — a privileged reorder can move it up — so branch on status, never on position.

GET/v1/claims/{claimId}

Path parameters

claimIdstringrequired

Responses

200The claim state

idstringrequired

positioninteger

min 0 · max 9007199254740991

expiresAtinteger

min -9007199254740991 · max 9007199254740991

fenceTokeninteger

min -9007199254740991 · max 9007199254740991

objectstringrequired

statusstringrequired

Allowed:activequeuedcommittedexpiredcanceled

400The request did not satisfy the published contract.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

401The Bearer credential is missing, malformed, or expired.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

403The credential does not authorize this operation.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

404The addressed resource does not exist in the credential scope.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

409The request conflicts with current claim, version, or idempotency state.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

429The caller exceeded an enforced rate limit.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

500The server could not complete the request.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

503A required service is temporarily unavailable.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

defaultAn HTTP error not otherwise listed; decoded through the canonical envelope.

typestringrequired

codestring

paramstring

messagestringrequired

doc_urlstring

request_idstring

errorsobject[]

Show properties

Array of object

codestring

messagestringrequired

paramstring

Request

curl -X GET "https://api.abloatai.com/api/v1/claims/string"

const response = await fetch("https://api.abloatai.com/api/v1/claims/string", {
  method: "GET"
});

import requests

response = requests.get(
    "https://api.abloatai.com/api/v1/claims/string",
)

Response

{
  "id": "string",
  "position": 0,
  "expiresAt": 0,
  "fenceToken": 0,
  "object": "claim",
  "status": "active"
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}

{
  "type": "string",
  "code": "string",
  "param": "string",
  "message": "string",
  "doc_url": "string",
  "request_id": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "param": "string"
    }
  ]
}