Skip to main content
GET
/
api
/
user-snapshots
/
{id}
/
apply-refs
Get apply references (pipeline stages and agents)
curl --request GET \
  --url https://your-instance.example.com/api/user-snapshots/{id}/apply-refs \
  --header 'Authorization: Bearer <token>'
{
  "stageRefs": [
    {
      "automationName": "Move to Contacted on first reply",
      "field": "targetStage",
      "value": "Contacted",
      "refType": "pipelineStage",
      "fieldLocation": "actions"
    }
  ],
  "agentRefs": [],
  "targetPipelines": [
    {
      "_id": "64eea1110000000000000010",
      "name": "Sales Funnel",
      "stages": [
        {
          "name": "New Lead",
          "color": "#3B82F6"
        },
        {
          "name": "Reached Out",
          "color": "#F59E0B"
        },
        {
          "name": "Closed Won",
          "color": "#10B981"
        }
      ]
    }
  ],
  "targetAgents": [
    {
      "_id": "64eea1110000000000000060",
      "name": "Default Agent",
      "description": "Standard AI agent."
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

Apply refs returned

stageRefs
object[]
agentRefs
object[]
targetPipelines
object[]
targetAgents
object[]