Get me | RealScout API documentation

Get me Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://bump.sh/realscout/doc/realscout-api/mcp

Standard setup for AI tools providing an mcp.json file

{
  "RealScout API MCP server": {
    "url": "https://bump.sh/realscout/doc/realscout-api/mcp"
  }
}

GET /me

Bearer auth

The calling agent's account as the Account page shows it: profile, brokerage and licensing, web presence, MLS memberships, contact-book and nurture settings, and the scopes this credential carries.

Requires the account:read scope. Rate budget: 300 calls per 1 minute per credential (the read class).

Responses

200 application/json

OK
Hide headers attributes Show headers attributes
- X-RateLimit-Limit integer
  
  Calls allowed in the current window.
- X-RateLimit-Remaining integer
  
  Calls left in the current window.
- X-RateLimit-Reset integer
  
  Epoch seconds at which the window resets.
Hide response attributes Show response attributes object
- id string Required
- first_name string | null Required
- last_name string | null Required
- full_name string | null Required
- email string | null Required
- secondary_email string | null Required
- phone_number string | null Required
- secondary_phone_number string | null Required
- sms_phone_number string | null Required
- photo_url string | null Required
- timezone string | null Required
- accepted_tos boolean | null Required
- created_at string(date-time) | null Required
- brokerage_name string | null Required
- enterprise_name string | null Required
- company_name string | null Required
- office_name string | null Required
- office_address string | null Required
- brokerage_license_number string | null Required
- license string | null Required
- licenses array[string] | null Required
- team object | null Required
  
  Hide team attribute Show team attribute object | null
  
  name string | null Required
- subdomain string | null Required
- search_page_url string | null Required
- landing_page_url string | null Required
- realscout_url string(uri) Required
- website_link string | null Required
- facebook_link string | null Required
- instagram_link string | null Required
- twitter_link string | null Required
- yelp_link string | null Required
- welcome_message string | null Required
- mls_memberships array[object] | null Required
  
  Hide mls_memberships attributes Show mls_memberships attributes object
  
  mls_name string Required
  
  display_name string Required
  
  status string Required
  
  Values are APPROVED, TEMPORARILY_APPROVED, SUBMITTED, SIGNATURES_NEEDED, DISABLED, REQUESTED, PENDING_VERIFICATION, ACCESS_REQUESTED_AWAITING_AGENT_INFO, PENDING_AGREEMENT_INITIATION, AGREEMENT_SENT_AWAITING_AGENT_SIGNATURE, AGREEMENT_SENT_AWAITING_BROKER_SIGNATURE, or AGREEMENT_SIGNED_AWAITING_RS_PROCESSING.
  
  has_access boolean Required
- auto_engage_new_clients boolean | null Required
- auto_engagement_type string | null Required
  
  Values are all, tagged, or null.
- nurtured_client_count integer | null Required
- nurtured_client_limit integer | null Required
- nurtured_clients_amount_over_limit integer | null Required
- cached_client_count integer | null Required
- cached_archived_contact_count integer | null Required
- default_cc_on_alerts boolean | null Required
- daily_client_activity_notifications boolean | null Required
- weekly_client_activity_notifications boolean | null Required
- scopes array[string] Required
400 application/json

The request is invalid; field names the offending input when there is one. A body that is not valid JSON is refused before the API runs, as a bare 400 with no body.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.
401 application/json

Invalid or missing bearer token.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.
403 application/json

The credential was not granted the scope this call requires.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.
404 application/json

Not found, or not yours: the two are indistinguishable on purpose.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.
429 application/json

Rate limit exceeded; Retry-After says when to try again.
Hide headers attribute Show headers attribute
- Retry-After integer
  
  Seconds until the budget refills.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.
500 application/json

Something went wrong on our side.
Hide response attribute Show response attribute object
- error object Required
  
  Hide error attributes Show error attributes object
  
  code string Required
  
  Values are internal_error, invalid_request, missing_scope, not_found, rate_limited, or unauthorized.
  
  message string Required
  
  field string
  
  The offending input, when one input is to blame.
  
  request_id string Required
  
  Quote this when reporting a problem; it identifies the call in our logs.

GET /me

curl -H "Authorization: Bearer rs_agent_..." https://www.realscout.com/api/agent/v1/me

Response examples (200)

{
  "id": "QWdlbnQtNDI=",
  "first_name": "Dana",
  "last_name": "Agent",
  "full_name": "Dana Agent",
  "email": "dana@example.com",
  "secondary_email": null,
  "phone_number": "555-0100",
  "secondary_phone_number": null,
  "sms_phone_number": "555-0100",
  "photo_url": "https://cdn.realscout.com/agents/42/photo.jpg",
  "timezone": "America/Los_Angeles",
  "accepted_tos": true,
  "created_at": "2024-08-01T00:00:00Z",
  "brokerage_name": "Example Realty",
  "enterprise_name": "Example Realty Group",
  "company_name": "Example Realty",
  "office_name": "Sunnyvale",
  "office_address": "456 Market St, Sunnyvale, CA 94086",
  "brokerage_license_number": "01234567",
  "license": "DRE 02012345",
  "licenses": [
    "DRE 02012345"
  ],
  "team": {
    "name": "Dana Agent Team"
  },
  "subdomain": "danaagent",
  "search_page_url": "https://danaagent.realscout.com",
  "landing_page_url": "https://danaagent.realscout.me",
  "realscout_url": "https://www.realscout.com/agent/account/profile",
  "website_link": "https://danaagent.example.com",
  "facebook_link": null,
  "instagram_link": null,
  "twitter_link": null,
  "yelp_link": null,
  "welcome_message": "Welcome! Let me know how I can help.",
  "mls_memberships": [
    {
      "mls_name": "MLSLISTINGS",
      "display_name": "MLSListings",
      "status": "APPROVED",
      "has_access": true
    }
  ],
  "auto_engage_new_clients": true,
  "auto_engagement_type": "all",
  "nurtured_client_count": 240,
  "nurtured_client_limit": 500,
  "nurtured_clients_amount_over_limit": 0,
  "cached_client_count": 312,
  "cached_archived_contact_count": 18,
  "default_cc_on_alerts": false,
  "daily_client_activity_notifications": true,
  "weekly_client_activity_notifications": true,
  "scopes": [
    "account:read",
    "contacts:read"
  ]
}

Response examples (400)

{
  "error": {
    "code": "invalid_request",
    "message": "unknown is not a field this endpoint takes.",
    "field": "unknown",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}

Response examples (401)

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing credentials.",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}

Response examples (403)

{
  "error": {
    "code": "missing_scope",
    "message": "This call requires the account:read scope, which this credential was not granted.",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}

Response examples (404)

{
  "error": {
    "code": "not_found",
    "message": "No endpoint at GET /api/agent/v1/me.",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}

Response examples (429)

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Try again in 30 seconds.",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}

Response examples (500)

{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side.",
    "request_id": "9b2f4c1e-7d3a-4e5b-8f6c-0a1d2e3f4b5c"
  }
}