Skip to content
AdCrunch
Esc
navigateopen⌘Jpreview

Read a mutation

Reports how a Mutation ended, or that it is still running.

running means the change has not finished. Poll again. complete means the provider accepted the change, and result carries what it returned — a created object arrives as its new id. errored means the change did not happen.

A Mutation belongs to one organization. An id from another organization and an id that never existed both answer 404, so a caller cannot learn which of the two it sent.

This needs mutation:write, not mutation:read. Polling is the second half of the write that started the Mutation, and the caller polling is the caller that started it. mutation:read reads the organization history through GET /mutations.

GET/mutations/{id}
Authorization
AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>. Two credentials work.

An API key (acr_…) is what a server integration uses. Create one in the AdCrunch console under Settings → API keys — see https://docs.adcrunch.dev/account/api-keys. A key is bound to the organization that was active when you created it, and it keeps acting on that organization whatever you do later. It carries the permissions of the member who created it.

A session issued by the AdCrunch sign-in flow also works, which is how the console calls this service from the browser.

Either way the organization comes from the credential. There is no organization parameter.

Path parameters
idstringrequired
Responses
200

The Mutation is running, complete, or errored.

resultany

What the provider returned. Present only when status is complete. A create carries the new object id.

statusstringrequired

running means poll again. complete means the provider accepted the change. errored means it did not happen.

Allowed:runningcompleteerrored
401

No credential, or one that does not resolve. Send an API key or a session. See the security scheme. error is unauthorized.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:unauthorized
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

403

The caller does not hold mutation:write. error is forbidden.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:forbidden
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

404

No such Mutation for your organization. error is not_found.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:not_found
messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

422

The request did not match this operation’s schema. This is the framework’s own shape, not the error/message one.

errorsobject[]required

One entry per failing field.

foundanyrequired

What was sent.

messagestringrequired
onstringrequired

Which part of the request failed: body, query or params.

propertystringrequired

The field that failed.

typestringrequired
Allowed:validation
Request
curl -X GET "https://api.adcrunch.dev/mutations/string" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "result": null,
  "status": "running"
}