API Reference

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: id, campaign_id, campaign_name, campaign_timezone, first_name, last_name, phone, email, custom, call_status, attempts_made, total_attempts, next_call_at, last_call_at, created_at, lead_ref, location_id, address. Nested records keep the operation's own field structure.

{
  "id": "00000000-0000-4000-8000-000000000001"
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: overview, per_day. Nested records keep the operation's own field structure.

{}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: id, call_kind, campaign_id, lead_id, attempt_number, started_at, ended_at, duration_sec, ended_reason, connected, voicemail, success, outcome, structured_output, structured_data, success_evaluation, transcript, summary, summary_score, deal_score, deal_band, deal_reason, dispositions. Nested records keep the operation's own field structure.

{
  "id": "00000000-0000-4000-8000-000000000001"
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: window, counters, deal_counters, leads_by_source, leads_by_assigned, dashboard, timeseries, weekly_recap, account_stats. Nested records keep the operation's own field structure.

{}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: id, name, entity_name, llc_name, phones, emails, do_not_contact, target_states, target_cities, target_zips, strategy, buyer_types, close_by, is_active, not_active_reason, pipeline_stage, tier, source, investor_notes, properties_per_month, deal_breakers, perfect_deal, asset_class, purchase_method, property_types, price_range, closing_timeline, address1, city, state, postal_code, custom, created_at, updated_at, notes. Nested records keep the operation's own field structure.

{
  "id": "00000000-0000-4000-8000-000000000001"
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: property_id, items, total, limit, offset, excluded_do_not_contact, scan_cap, truncated, weights. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: id, address, street, city, state, zip, status, fell_through_reason, exit_type, contract_price, asking_price, arv, repair_estimate, assignment_fee_target, comp_id, beds, baths, sqft, year_built, listed_on_mls, mls_list_date, mls_list_price, mls_number, offer_deadline, description, access_notes, title_company, emd_terms, contract_date, close_date, notes, apn, purchase_emd_amount, purchase_closing_date, contract_inspection_end_date, created_at, updated_at, external_ref, source_type, intake_source, jv_contact_id, jv_split_pct, seller_crm_contact_id, active_transaction_id, deal_page_published, owners. Nested records keep the operation's own field structure.

{
  "id": "00000000-0000-4000-8000-000000000001"
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: property_id, current_stage, stages, fall_through_categories, fall_through_attributions, buyer_and_fee_stages. Nested records keep the operation's own field structure.

{}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: id, status, address, street, city, state, postal_code, arv_multiplier, wholesale_fee, holding_cost, rehab_override, arv, arv_low, arv_high, as_is, mao, cash_offer, open_offer, open_gross, cash_gross, mao_gross, ai_rehab, rent, beds, baths, sqft, year_built, lot_sqft, confidence, manual_review, review_reason, note_text, report_markdown, selected_strategy, revision_number, ran_at, received_at, updated_at, candidates, underwriting. Nested records keep the operation's own field structure.

{
  "id": "00000000-0000-4000-8000-000000000001"
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: id, name, status, campaign_type, dialer_mode, timezone, start_date, end_date, days_of_week, call_window_start, call_window_end, total_attempts, max_daily_attempts, min_redial_wait_min, voicemail_is_answered, outbound_cold_calling, dial_state, lead_stats, summary, created_at. Nested records keep the operation's own field structure.

{
  "id": "00000000-0000-4000-8000-000000000001"
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: id, property_id, name, status, channels, audience_kind, segment_id, subject, body_email, body_sms, scheduled_at, created_at, updated_at, funnel. Nested records keep the operation's own field structure.

{
  "id": "00000000-0000-4000-8000-000000000001"
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: balance_credits, paused_nonpayment, auto_refill_enabled, auto_refill_threshold_credits, auto_refill_amount_cents, has_auto_refill_payment_method, lifetime_purchased_cents, lifetime_credits_added, lifetime_credits_used. Nested records keep the operation's own field structure.

{}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: id, property_id, address, city, state, zip, property_status, exit_strategy, ratification_date, seller_emd_amount, seller_emd_holder, seller_emd_deadline, seller_emd_received_at, buyer_emd_amount, buyer_emd_holder, buyer_emd_deadline, buyer_emd_received_at, title_company, title_officer, title_phone, title_email, title_file_number, title_order_date, title_commitment_date, clear_to_close_at, audit_flags, cycle_number, cycle_status, cycle_started_at, cycle_ended_at, cycle_reason, gross_assignment_fee, actual_deal_profit, gross_listing_commission, deal_expenses, first_scheduled_closing_date, second_scheduled_closing_date, created_at, updated_at, section19_notes, owners. Nested records keep the operation's own field structure.

{
  "id": "00000000-0000-4000-8000-000000000001"
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 100,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: id, property_id, buyer_id, buyer_name, buyer_entity_name, address, city, state, zip, property_status, asking_price, contract_price, assignment_fee_target, amount, status, source, close_by, inspection_end_date, emd_amount, emd_due_at, emd_received, emd_received_at, contract_sent, contract_sent_at, contract_signed, contract_signed_at, has_proof_of_funds, funding_type, funding_other, fell_through_reason, public_submission_id, notes, created_at, updated_at. Nested records keep the operation's own field structure.

{
  "id": "00000000-0000-4000-8000-000000000001"
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items, total, limit, offset, window_start, window_end. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items, total, limit, offset, window_start, window_end, totals. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items, total, limit, offset, includes_pending_review. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: id, property_id, transaction_id, address, city, state, zip, property_status, contract_price, asking_price, assignment_fee_target, status, first_close_at, activated_at, target_completion_date, actual_completion_date, planned_listing_date, listing_ready_at, listed_at, second_close_at, occupancy_status, possession_date, tenant_move_out_date, occupancy_notes, utilities_status, utilities_notes, alarm_configured, lockbox_installed, holdback_amount, holdback_release_date, final_profit, non_rehab_deal_expenses, project_notes, scope_item_count, scope_open_count, scope_estimate_total, scope_committed_total, scope_invoiced_total, scope_paid_total, task_count, task_done_count, task_blocked_count, task_overdue_count, created_at, updated_at. Nested records keep the operation's own field structure.

{
  "id": "00000000-0000-4000-8000-000000000001"
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items, total, limit, offset, includes_archived. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items, total, limit, offset, totals. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items, total, limit, offset, active_only. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: configured, first_close_basis, tier_period, updated_at, plan_count, tier_count. Nested records keep the operation's own field structure.

{}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items, total, window_start, window_end, timezone. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: items, total, limit, has_more, sort_direction, snapshot_generated_at, snapshot_report_id. Nested records keep the operation's own field structure.

{
  "items": []
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: client_id, name, slug, status, account_type, timezone, primary_email, primary_phone, created_at, archived_at, access_revoked_at, plan_name, plan_cancel_at_period_end, plan_canceled_at, plan_started_at, resources. Nested records keep the operation's own field structure.

{
  "client_id": "00000000-0000-4000-8000-000000000001"
}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - CRM installation status.

JSON object with fields: installed. Nested records keep the operation's own field structure.

{
  "installed": false
}

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: steps, completed_count, total_count, all_complete, dismissed, celebrated, celebrate, visible. Nested records keep the operation's own field structure.

{}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - The operation's source-defined result.

JSON object with fields: profile_id, email, member_role, workspace_role, profile_created_at, joined_at, workspace_count, primary_workspace_id, primary_workspace_name, surface_override_count, surface_disabled_count. Nested records keep the operation's own field structure.

{}

• Synthetic excerpt only, not the complete response or an exhaustive schema. Field values and nested records depend on your account.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

404 - No record visible to this credential.

JSON object: error

{
  "error": "not_found"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}

503 - The service or a required dependency is unavailable.

JSON object: error

{
  "error": "unavailable"
}

200 - A page of matching records.

JSON object with fields: items, total, limit, offset. Nested records keep the operation's own field structure.

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

• Synthetic valid empty page, not an observed account response. Row objects are absent because this example has no matches.

400 - A parameter or body value is invalid.

JSON object: error

{
  "error": "bad_request"
}

401 - Missing, invalid, expired, revoked or insufficiently scoped credential.

JSON object: error

{
  "error": "unauthorized"
}

429 - A request limit was exceeded.

JSON object: error

{
  "error": "rate_limited"
}

502 - An upstream response could not be used.

JSON object: error

{
  "error": "upstream"
}