catchUpOnBid
Requires permission biddesk:bid:read.
Tells the caller, in a few sentences with links, what changed on a bid since they last looked: decisions, stage moves, escalations, threads, tasks, files, and what now waits on them. A mutation because it may make a paid model call and writes a trace row. Without the AI add-on, or when the model is unavailable, the same items come back as a list (status LIST, with a code). A bid the caller may not see is not found. Requires Bid Desk and permission to read bids.
Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.
Example:
- GraphQL
- cURL
mutation CatchUpOnBid($bidId: ID!) {
catchUpOnBid(bidId: $bidId) {
code
status
since
truncated
items {
actor
count
group
kind
path
text
}
}
}
curl -X POST "https://<api-host>/graphql" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
--data @- <<'EOF'
{
"query": "mutation CatchUpOnBid($bidId: ID!) {\n catchUpOnBid(bidId: $bidId) {\n code\n status\n since\n truncated\n items {\n actor\n count\n group\n kind\n path\n text\n }\n }\n}",
"variables": {
"bidId": "id"
}
}
EOF
Variables:
{
"bidId": "id"
}
Response:
{
"data": {
"catchUpOnBid": {
"code": "string",
"status": "LIST",
"since": "2025-01-15T00:00:00Z",
"truncated": true,
"items": [
{
"actor": "string",
"count": 0,
"group": "string",
"kind": "string",
"path": "string",
"text": "string"
}
]
}
}
}
catchUpOnBid(
bidId: ID!
since: DateTime
): BidCatchUp!
Arguments
catchUpOnBid.bidId ● ID! non-null scalar
The bid.
catchUpOnBid.since ● DateTime scalar
Where the window starts, within the last 30 days. Omit for since the caller's last visit.
Type
BidCatchUp object
What changed on a bid since the caller last looked. Counts and bid numbers come from the activity stream, never from the model.