APIPay Out endpointsVendor

Get outreach call status

Beta
View as MarkdownOpen in Claude

Returns the latest AI outreach call activity for a vendor. The response is a composite object with a state discriminator (none, scheduled, successful, or failed); the block that matches the current state is populated. When the vendor has no call activity, state is none and the response returns HTTP 200.

Authentication

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

OR
AuthorizationBearer

OAuth2 Bearer access token from the client-credentials flow. See OAuth authentication.

Path parameters

idVendorlongRequired
ID of the vendor to read call status for.

Response

Success
vendorIdlong
ID of the vendor this status applies to.
statestring

Current call state. Values are: none (no call activity for the vendor), scheduled (a call is queued or being retried), successful (a call completed and returned data), or failed (the call didn’t complete successfully).

scheduledobject

Populated when state is scheduled.

completedobject

Populated when state is successful.

failedobject

Populated when state is failed.

Errors

401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error