Skip to main content
GET
/
prop
/
journeys
List Journeys
curl --request GET \
  --url https://api.{your-broker}.slate-labs.com/prop/journeys \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "journey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_name": "<string>",
      "customer_email": "<string>",
      "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "template_name": "<string>",
      "account_currency": "<string>",
      "status": "<string>",
      "current_phase": "<string>",
      "current_account_login": "<string>",
      "profit_to_date": 123,
      "profit_target": 123,
      "total_paid": 123,
      "total_paid_currency": "<string>",
      "created_at": "<string>"
    }
  ],
  "total": 123,
  "aggregates": {
    "active_count": 123,
    "completed_count": 123,
    "breached_count": 123,
    "total_revenue_usd": 123,
    "total_paid_out_usd": 123,
    "pending_payout_usd": 123
  },
  "_meta": {
    "permissions": {
      "can_grant_journey": false,
      "can_reset_journey": false,
      "can_cancel_journey": false
    }
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

status
string | null
template_id
string<uuid> | null
customer_id
string<uuid> | null
q
string | null
limit
integer
default:100
offset
integer
default:0

Response

Successful Response

items
JourneyListItem · object[]
required
total
integer
required
aggregates
JourneysAggregates · object
required
_meta
JourneyMeta · object