Surface

Get authenticated user's Surface context

Returns the authenticated user's organization, job role, role orientation, person profile, roles, and representatives for Surface prompt resolution.

get/api/me/surface/context

Request

Response

Surface context

Example response

{
  "data": {
    "organization_id": 123,
    "job_role": {
      "id": 1,
      "name": "Marketing"
    },
    "role_orientation": {
      "id": 2,
      "name": "buy_side"
    },
    "person_profile": {
      "info": "Experienced marketer",
      "job_title": "VP of Marketing",
      "location": "New York, NY",
      "person_profile_job_role": {
        "id": 1,
        "name": "Marketing"
      }
    },
    "organization": {
      "id": 123,
      "name": "Acme Corp",
      "organization_type": {
        "id": 1,
        "name": "Brand"
      }
    },
    "roles": [
      {
        "display_name": "Scout"
      }
    ],
    "representative": {
      "id": 10,
      "type": "brand",
      "name": "Nike",
      "category_id": 5,
      "category_name": "Apparel",
      "subcategory_id": 12
    },
    "representatives": [
      {
        "id": 10,
        "type": "brand",
        "name": "Nike",
        "is_main": true,
        "category_id": 5,
        "category_name": "Apparel",
        "subcategory_id": 12
      }
    ],
    "organization_surface_context": "We prioritize NBA and MLS partnerships.",
    "user_surface_context": "I focus on NBA sponsorship deals.",
    "admin_organization_surface_context": "Enterprise account, renewal Q3.",
    "admin_user_surface_context": "Long-time client contact. Prefers NBA/MLS comps."
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.