Read agent state for a property
Returns whether the agent is enabled for one property, and when that last changed. Staff enable or
disable the agent per property in Fortress’ agent configuration. While isEnabled is false, the
agent does no work for that property.
A property that has never been configured returns isEnabled: false and updatedAt: null.
For agentKey: cora the response also carries cadencePolicy: the outreach cadence CORA executes for
the property. It is the policy staff stored for the property, or the baseline seed when the property never
set one, so a property with no CORA configuration also gets the default. Leslie responses do not carry it.
cadencePolicy.isFallback is read-only: true when the property has no stored policy and Fortress
returns its default (the baseline seed, with expireAfterLastTouchpoint of 7 days), false for the
property’s stored policy. Staff set the policy in Fortress; there is no partner write. Read it as data
and do not hard-code the timing.
The agent.state_changed webhook is sent
when staff flip the switch (scope: PROPERTY), including when deleting an enabled configuration
disables the agent. It is also sent when staff change the CORA cadence policy: re-read this route and
apply the new policy from the next touchpoint. Read the state on startup and after a missed webhook.
The API key needs the agents: read permission to call this endpoint, and the property must belong
to the key’s organization.
Authenticate with the x-api-key header. agentKey is cora or leslie; any other value returns 404 AGENT_NOT_FOUND. Clients must branch on code, not on message.
Authentication
Path parameters
The agent, cora or leslie. Any other value returns 404 AGENT_NOT_FOUND.
Query parameters
Response
The agent, cora or leslie.
Whether the agent is enabled for the property. false: the agent does no work for the property until it is enabled again. false when the property has never been configured.
When the state last changed for the property. null when the property has never been configured.
The outreach cadence CORA executes for the property. Returned only for agentKey: cora: the policy staff stored for the property, or the default (the baseline seed, isFallback: true) when the property never set one or has no CORA configuration. Not returned for leslie. Staff set the policy in Fortress; there is no partner write. Read it as data, never hard-code it.