Skip to main content

​
Get Process

Use GET /processes/{process_id} to retrieve the current normalized public process record. 
GET /processes/{process_id}

​
When To Use It

Use this endpoint as the source of truth for:
  • current public status
  • resolved target assignment
  • callbacks configured for the process
  • error summary
  • linked queue-item ids
  • partial progress

​
Request Example

curl "$PHONEFARM_BASE_URL/processes/$PROCESS_ID" \
  -H "Authorization: Bearer $PHONEFARM_API_KEY"

​
Response Example

{
  "process_id": "3e6f2e7b-4e3c-4c7c-b8d7-0c53d83f9870",
  "process_type": "keyword_warmup",
  "request_id": "warmup-2026-03-22-001",
  "status": "executing",
  "target": {
    "account_id": "account_user095916355",
    "phone_id": "phone_01"
  },
  "requested_by": {
    "system": "ugc-tracker",
    "user": "operator@example.com",
    "metadata": {}
  },
  "callback": {
    "url": "https://ugc-tracker.example.com/phonefarm/process-updates",
    "metadata": {
      "environment": "production"
    }
  },
  "result": {},
  "error": null,
  "timestamps": {
    "created_at": "2026-03-22T08:30:00.000Z",
    "accepted_at": "2026-03-22T08:30:00.000Z",
    "queued_at": "2026-03-22T08:30:00.000Z",
    "executing_at": "2026-03-22T08:31:10.000Z",
    "retrying_at": null,
    "cancel_requested_at": null,
    "finished_at": null
  },
  "linked_ids": {
    "queue_item_ids": ["7c1a07f6-1d55-4f79-a403-8a8420f1b62b"],
    "completed_queue_item_ids": []
  },
  "partial_progress": {}
}

​
Response Fields

FieldTypeNotes
process_idstringStable process identifier.
process_typestringCapability or process family.
request_idstring or nullCaller-provided request id.
statusstringPublic normalized status.
targetobjectCurrent account and phone target view.
requested_byobjectOriginal caller identity payload.
callbackobject or nullCallback target and metadata.
resultobjectResult metadata collected so far.
errorobject or nullTerminal or current error summary.
timestampsobjectMilestone-derived timestamps.
linked_idsobjectQueue-item relationships.
partial_progressobjectPartial completion details when relevant.

​
error

When present: 
{
  "message": "operator requested stop",
  "category": "cancelled"
}

​
linked_ids

{
  "queue_item_ids": ["7c1a07f6-1d55-4f79-a403-8a8420f1b62b"],
  "completed_queue_item_ids": []
}

​
Timestamp Precision

Public timestamps are useful for sequencing, not device-level audit precision.
  • accepted_at comes from the accepted milestone.
  • queued_at comes from the planned milestone.
  • executing_at is sourced from queue-item materialization.
  • finished_at is derived from terminal row update time.

​
Failure Modes

Status codeMeaning
401Missing or invalid bearer token.
404Process id not found.
500Unexpected process lookup failure.