Skip to main content
GET
Get a follow-up
Poll this after Create a follow-up. While status is waiting, next_check_at is when the place is looked in next and checks how many times it has been. Once status is done, outcome is found, time_up, or expired, and found holds only the thing that arrived: its kind, a one-line summary, and the code, link, file_url and file_name, or a short text, with sender, subject, and received_at. note is one plain line on how it ended. cancelled and failed follow-ups stay readable; failed means the place could not be checked (note says why, for example the app was disconnected). Only your own; anyone else gets 404. Needs followups:read. MCP tool: get_followup.

Authorizations

Authorization
string
header
required

API key with the vd_sk_ prefix, as Authorization: Bearer vd_sk_.... Create keys in Settings → API Keys.

Path Parameters

followup_id
string
required

Response

The follow-up: once it ended, its outcome and what was found.

id
string
required
agent
enum<string>
required

Who is waiting: api for one made here; igris, session or brain for one an in-app agent made.

Available options:
igris,
session,
brain,
api
what
string
required
where
FollowupWhere · object
required
status
enum<string>
required

waiting: timed and checked. done: ended (outcome says how). cancelled. failed: could not be checked (note says why).

Available options:
waiting,
done,
cancelled,
failed
conversation_id
string
default:""

The session or workflow of an in-app agent; empty here.

match
FollowupMatch · object
outcome
enum<string> | null

found: it arrived (found holds it). time_up: a check-back's time came. expired: nothing came in time.

Available options:
found,
time_up,
expired
found
FollowupFound · object | null

The thing that arrived — only it, never the rest of the mailbox.

note
string | null

One plain line on how it ended.

since
string<date-time> | null

Only things that arrived after this count.

next_check_at
string<date-time> | null
deadline
string<date-time> | null
checks
integer
default:0

How many times the place was looked in.

created_at
string<date-time> | null
ended_at
string<date-time> | null