get_app
const url = 'https://app.everruns.com/api/v1/apps/example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://app.everruns.com/api/v1/apps/exampleGet an archival App record. This endpoint is read-only and deprecated.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”App ID
Responses
Section titled “ Responses ”Archival App record
Wrapper that adds API and UI links to a serialized resource.
Uses self_url (not url) for the API link to avoid collision with
resources that already have a url field (e.g. McpServer). The
allowed_actions array carries state-aware hypermedia links — empty
(and omitted from the wire shape) until the underlying resource opts
into the convention by overriding ResourceUrlable::allowed_actions.
object
Optional ID of the agent to use (format: agent_{32-hex}).
Timestamp when the app was archived.
Distribution channels attached to this app.
An independently published communication channel owned by an Agent. Each channel has its own type, config, and lifecycle status.
object
Authentication policy for this channel.
object
Agent channel authentication mode.
Stored on AgentChannel.auth so users can protect one endpoint without first
creating org-level identity-provider state.
object
object
object
object
object
Shared secret the trusted proxy includes in proxy_secret_header.
Write-only: redacted in GET responses. See TM-AUTH-021.
Header the trusted reverse proxy uses to prove its identity. Required. Configs without this field fail closed at verification time.
Claim and credential requirements common to channel auth providers.
object
JWT aud values to require on inbound tokens. Empty list disables audience checking.
Arbitrary claim equality predicates. Empty map disables claim filtering.
object
Allowlist of email/identifier domains. Empty list disables domain filtering.
Allowlist of group memberships (from groups claim). Empty list disables group filtering.
OAuth scope strings to require (space-delimited per scope entry). Empty list disables scope checking.
Allowlist of sub claim values. Empty list disables subject filtering.
Channel-specific configuration (validated per channel type).
Channel type (e.g. slack).
Timestamp when this channel was created.
Whether this channel is enabled.
External identifier (appchan_<32-hex>). Shown as “id” in API.
Per-channel lifecycle. Authoritative for ingress (EVE-1007); enabled
is retained for the App API’s existing shape.
Timestamp when this channel was last updated.
Timestamp when the app was created.
Timestamp when the app was deleted.
Human-readable description of what the app does.
ID of the harness to use (format: harness_{32-hex}).
External identifier (app_<32-hex>). Shown as “id” in API.
Display name of the app.
Owning principal for this app.
Timestamp when the app was last published.
Denormalized effective human owner of the owning principal lineage.
Current lifecycle status.
Timestamp when the app was last updated.
Optional virtual identity that represents the app in unattended/channel execution.
State-aware hypermedia actions the caller can take on this resource
next (e.g. cancel, events, update). Omitted from the wire
shape when empty so resources that haven’t opted into the
convention don’t grow their payloads.
Agent-actionable link describing a follow-up the caller can take. Used in two contexts:
- Error recovery —
ErrorResponse.allowed_actionscarriesrels likeretry,retry-later,unarchive,get-existingso the agent knows the right next call after a 4xx/429. - Entity hypermedia —
WithUrls<T>.allowed_actionscarries state-awarerels likecancel,events,self,updateon the entity itself so the agent can follow links instead of reconstructing routes from prose.
The shape is intentionally identical across both contexts; the closed
rel vocabulary distinguishes them.
object
Short, agent-readable hint (e.g. “Shorten ‘name’ to <= 200 chars.”, “Cancel the active turn for this session.”).
Absolute (preferred) or relative URL the caller may invoke
directly. Always present on entity hypermedia actions
(WithUrls<T>.allowed_actions); optional on error-recovery
actions (ErrorResponse.allowed_actions) where the matching
operation_id is enough and the URI is implicit from the failed
call.
HTTP method to use against href. Required for entity hypermedia
actions; usually omitted on error-recovery actions where the same
operation is retried with its original method.
OpenAPI operationId the caller should invoke. Lets an MCP client
resolve the call without parsing href.
Link relation describing the action. Examples: self, cancel, pause,
resume, events, retry, retry-later, unarchive,
get-existing, delete, update.
OpenAPI $ref to the request-body schema, when the action takes one
(e.g. #/components/schemas/UpdateSessionRequest). Lets a tool-calling
agent fetch the input shape without scanning the whole spec.
Full API endpoint URL for this resource.
Alias for view_url, used by command and MCP outputs.
Full UI URL for viewing this resource.
Example
{ "agent_id": "agent_01933b5a00007000800000000000001", "channels": [ { "auth": { "mode": "api_key", "requirements": { "audiences": [ "everruns-api" ], "scopes": [ "app:invoke" ] } }, "channel_type": "slack", "id": "appchan_01933b5a000070008000000000000001", "status": "draft" } ], "effective_owner": { "id": "principal_01933b5a000070008000000000000001", "kind": "user" }, "harness_id": "harness_01933b5a00007000800000000000001", "id": "app_01933b5a000070008000000000000001", "owner": { "id": "principal_01933b5a000070008000000000000001", "kind": "user" }, "owner_principal_id": "principal_01933b5a000070008000000000000001", "status": "draft", "virtual_user_id": "identity_01933b5a00007000800000000000001", "allowed_actions": [ { "method": "POST" } ]}Invalid App ID
App not found
Internal server error