getUser
Retrieve a single member record by user ID, with optional inclusion of fields such as subscription, photos, transactions, and other details.
Instructions
Get a single member/user - Fetch a single user record. Read-only.
Lean-by-default keep-list: same shape as listUsers — identity + routing + location core (user_id, first_name, last_name, email, company, phone_number, subscription_id, profession_id, active, status, city, state_code, country_code, filename, image_main_file, signup_date, last_login, modtime). Restore extras via flags: include_password=1, include_subscription=1, include_clicks=1, include_photos=1, include_transactions=1, include_profession=1, include_tags=1, include_services=1, include_seo_hidden=1, include_about=1, include_legacy_fields=1, include_extras=1 (billing/analytics rollups revenue/card_info/total_clicks/total_photos, duplicate location fields state_ln/country_ln/full_name/user_location/zip_code/lat/lon, plus social URLs, awards, credentials, position, quote, work_experience, ref_code, booking_link, etc.).
Use when: you already have the user_id (from listUsers, searchUsers, a prior create, or a webhook payload) and need the full member record. Cheaper than listUsers + filter. For lookups by email or other field, use listUsers with property/property_value.
Required: user_id.
See also: listUsers (enumerate many), searchUsers (keyword search).
Returns: { status: "success", message: [{...record}] } - the message array contains 1 lean-shaped record when found. Empty or HTTP 404 when not found.
Payment method on file (under include_extras=1): card_info is false when no card is stored (BD convention), or an object with last4/brand/name when one is. Use card_info && card_info.last4 to safely check. Authoritative signal for "does this member have a payment method" — don't infer from subscription_id alone.
Profile URL: every user record has a filename field. To get the full public profile URL, concatenate: <site-domain>/<user.filename>. The filename is the complete relative path (e.g., united-states/monterey-park/doctor/harrison-hasanuddin-d-o) - DO NOT prepend /business/, /profile/, /member/, or any other segment. BD's router resolves filename verbatim. Note: filename is regenerated by BD when member inputs that influence the slug change (category, city, etc.). The value you see NOW is current-as-of-this-read. If you call updateUser afterward, re-fetch before using the filename in URL-referencing content (blog posts, emails, redirects).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | ||
| include_password | No | Opt in to return bcrypt `password` hash. Default stripped. | |
| include_subscription | No | Opt in to return full `subscription_schema` (60+ plan fields). Default: `subscription_id` only. | |
| include_clicks | No | Opt in to return `user_clicks_schema.clicks` array. Default: `total_clicks` count surfaced only when > 0; absent means zero clicks. | |
| include_photos | No | Opt in to return `photos_schema` array. Default: `total_photos` count only (`image_main_file` URL always returned). | |
| include_transactions | No | Opt in to return full `transactions` invoice array. Default stripped (`revenue` rollup always returned). | |
| include_profession | No | Opt in to return `profession_schema` (category metadata). Default: `profession_id` only. | |
| include_tags | No | Opt in to return `tags` array. Default stripped. | |
| include_services | No | Opt in to return `services_schema` sub-category array. Default stripped. | |
| include_seo_hidden | No | Opt in to return SEO meta fields (`seo_page_*_hidden`, `seo_social_*_hidden`, `search_description`). Default stripped. | |
| include_about | No | Opt in to return the `about_me` HTML bio. Default stripped. | |
| include_legacy_fields | No | Return image-import state on `photos_schema` rows: `original`, `resized`, `error`. Requires `include_photos=1`. | |
| include_extras | No | Opt in to return ALL remaining fields on this resource that are not in the lean-by-default keep-list and not gated by another `include_*` flag. Lean default returns only the core identity, routing, and load-bearing fields. `include_extras=1` restores everything else (geo, all hero_*, layout/sidebar/menu config, all display toggles, admin metadata, etc.). Resource-specific — see each tool's description for what the extras bundle contains. |