> ## Documentation Index
> Fetch the complete documentation index at: https://developers.investorlift.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read what this token can do

> Reads the account behind this token: the person, the organization and the role. It also carries the designations and the sides the token reaches. It names the trust tier with each fact and its source. The fact strike_tier_drop lowers the tier by one for 7 days. The fact strike_hold sends each write to the hold queue. It names what is left of each cap today, and the terms each side accepted. This operation answers before a side accepts the terms.



## OpenAPI

````yaml /marketplace/openapi.json get /me
openapi: 3.1.0
info:
  title: Investorlift Marketplace API
  version: '2026-09-18'
  summary: List, publish and trade wholesale real estate deals on Investorlift.
  description: >-
    The Marketplace API gives a seller organization and a buyer account the same
    actions the Investorlift application gives them. A seller creates a draft,
    publishes a deal, reads its leads and answers offers. A buyer searches
    deals, asks for an address, makes an offer and keeps a buy box. Every answer
    carries a request id, and every refusal carries a problem code with one
    recovery sentence.
  contact:
    name: Investorlift support
    email: support@investorlift.com
servers:
  - url: https://api.investorlift.com/marketplace/v1
    description: Production
security:
  - oauth2: []
tags:
  - name: sell
    description: What a seller organization does with its drafts and deals.
  - name: buy
    description: What a buyer account does with deals, offers and buy boxes.
  - name: me
    description: What this token can do right now.
  - name: events
    description: >-
      What Investorlift sends to a webhook endpoint, one entry for each event
      type.
paths:
  /me:
    get:
      tags:
        - me
      summary: Read what this token can do
      description: >-
        Reads the account behind this token: the person, the organization and
        the role. It also carries the designations and the sides the token
        reaches. It names the trust tier with each fact and its source. The fact
        strike_tier_drop lowers the tier by one for 7 days. The fact strike_hold
        sends each write to the hold queue. It names what is left of each cap
        today, and the terms each side accepted. This operation answers before a
        side accepts the terms.
      operationId: getMarketplaceMe
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Me'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
                additionalProperties: false
        '401':
          description: Not authenticated
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem.unauthorized'
        '403':
          description: Refused, Scope missing
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/problem+json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Problem.forbidden'
                  - $ref: '#/components/schemas/Problem.insufficient_scope'
        '405':
          description: Method not allowed
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem.method_not_allowed'
        '503':
          description: Service unavailable
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem.origin_error'
      security:
        - oauth2:
            - marketplace:profile
components:
  headers:
    XRequestId:
      description: The id this answer shares with the Investorlift request log.
      schema:
        type: string
  schemas:
    Me:
      type: object
      properties:
        user:
          type: object
          properties:
            id:
              anyOf:
                - type: string
                - type: 'null'
              description: >-
                The buyer id, byr_<person id>, or null when this account buys
                nothing.
            name:
              type: string
            email:
              type: string
            email_verified:
              type: boolean
            phone_verified:
              type: boolean
          required:
            - id
            - name
            - email
            - email_verified
            - phone_verified
          additionalProperties: false
        organization:
          anyOf:
            - type: object
              properties:
                id:
                  type: string
                  description: The seller id, slr_<organization id>.
                name:
                  type: string
                slug:
                  type: string
                role:
                  type: string
                  enum:
                    - member
                    - admin
                    - owner
                designations:
                  type: array
                  items:
                    type: string
              required:
                - id
                - name
                - slug
                - role
                - designations
              additionalProperties: false
            - type: 'null'
          description: >-
            The caller's own organization, never the Mogul Buyers holding
            organization.
        designations:
          type: array
          items:
            type: string
          description: The designations of the person and that organization.
        sides:
          type: array
          items:
            type: string
            enum:
              - sell
              - buy
          description: The sides this account reaches today.
        scopes:
          type: array
          items:
            type: string
          description: The scopes this token carries.
        client_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The OAuth client the token was minted for.
        trust:
          type: object
          properties:
            tier:
              type: string
              enum:
                - T0
                - T1
                - T2
                - T3
            facts:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                    description: The fact, for example phone_verified.
                  value:
                    type: boolean
                    description: What the fact says today.
                  source:
                    type: string
                    description: The column or the function the fact is read from.
                required:
                  - name
                  - value
                  - source
                additionalProperties: false
            next_step:
              anyOf:
                - type: string
                - type: 'null'
              description: >-
                What this account does next to reach the tier above, or null at
                T3.
          required:
            - tier
            - facts
            - next_step
          additionalProperties: false
        caps:
          type: array
          items:
            type: object
            properties:
              action:
                type: string
                description: The action the cap counts.
              limit:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
                description: How many this account does in one UTC day.
              used:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
                description: How many it did today.
              remaining:
                type: integer
                minimum: -9007199254740991
                maximum: 9007199254740991
                description: How many are left today.
              resets_at:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                description: The next midnight in UTC.
            required:
              - action
              - limit
              - used
              - remaining
              - resets_at
            additionalProperties: false
        terms:
          type: object
          properties:
            sell:
              type: object
              properties:
                accepted:
                  type: boolean
                  description: True when this side accepted the terms.
                agreement_id:
                  type: string
                  description: The agreement the acceptance is keyed on.
              required:
                - accepted
                - agreement_id
              additionalProperties: false
            buy:
              type: object
              properties:
                accepted:
                  type: boolean
                  description: True when this side accepted the terms.
                agreement_id:
                  type: string
                  description: The agreement the acceptance is keyed on.
              required:
                - accepted
                - agreement_id
              additionalProperties: false
          required:
            - sell
            - buy
          additionalProperties: false
        environment:
          type: string
          enum:
            - sandbox
            - production
          description: >-
            sandbox on the stage host and in development, production on the live
            host.
        api_version:
          type: string
      required:
        - user
        - organization
        - designations
        - sides
        - scopes
        - client_id
        - trust
        - caps
        - terms
        - environment
        - api_version
      additionalProperties: false
    Meta:
      type: object
      properties:
        request_id:
          type: string
          description: The id this answer shares with the log.
        api_version:
          type: string
          description: The contract version the body is rendered at.
      required:
        - request_id
        - api_version
      additionalProperties: false
    Problem.unauthorized:
      allOf:
        - $ref: '#/components/schemas/Problem'
      description: >-
        Not authenticated. Send a current access token for this API, and start a
        new authorization when the token is expired.
      properties:
        type:
          const: https://developers.investorlift.com/marketplace/errors#unauthorized
        title:
          const: Not authenticated
        status:
          const: 401
        code:
          const: unauthorized
        recovery:
          const: >-
            Send a current access token for this API, and start a new
            authorization when the token is expired.
    Problem.forbidden:
      allOf:
        - $ref: '#/components/schemas/Problem'
      description: >-
        Refused. Ask Investorlift support why the account, the client or the
        organization is stopped.
      properties:
        type:
          const: https://developers.investorlift.com/marketplace/errors#forbidden
        title:
          const: Refused
        status:
          const: 403
        code:
          const: forbidden
        recovery:
          const: >-
            Ask Investorlift support why the account, the client or the
            organization is stopped.
    Problem.insufficient_scope:
      allOf:
        - $ref: '#/components/schemas/Problem'
      description: >-
        Scope missing. Start a new authorization that asks for the scope named
        in the detail.
      properties:
        type:
          const: >-
            https://developers.investorlift.com/marketplace/errors#insufficient_scope
        title:
          const: Scope missing
        status:
          const: 403
        code:
          const: insufficient_scope
        recovery:
          const: >-
            Start a new authorization that asks for the scope named in the
            detail.
        scope:
          type: string
          enum:
            - marketplace:profile
            - deals:read
            - deals:write
            - offers:read
            - offers:write
            - inquiries:read
            - inquiries:write
            - leads:read
            - leads:write
            - contacts:read
            - reviews:read
            - buy_boxes:manage
            - webhooks:manage
            - events:read
          description: The scope this operation needs.
      required:
        - scope
    Problem.method_not_allowed:
      allOf:
        - $ref: '#/components/schemas/Problem'
      description: >-
        Method not allowed. Use one of the methods the documentation lists for
        this path.
      properties:
        type:
          const: >-
            https://developers.investorlift.com/marketplace/errors#method_not_allowed
        title:
          const: Method not allowed
        status:
          const: 405
        code:
          const: method_not_allowed
        recovery:
          const: Use one of the methods the documentation lists for this path.
    Problem.origin_error:
      allOf:
        - $ref: '#/components/schemas/Problem'
      description: >-
        Service unavailable. Repeat the call in a minute, and tell Investorlift
        support when the answer stays the same.
      properties:
        type:
          const: https://developers.investorlift.com/marketplace/errors#origin_error
        title:
          const: Service unavailable
        status:
          const: 503
        code:
          const: origin_error
        recovery:
          const: >-
            Repeat the call in a minute, and tell Investorlift support when the
            answer stays the same.
    Problem:
      type: object
      description: >-
        One refusal, as RFC 9457 application/problem+json. The code picks the
        status, the title and the recovery sentence.
      properties:
        type:
          type: string
          format: uri
          description: The errors page anchor of the code.
        title:
          type: string
          description: The short title of the code.
        status:
          type: integer
          description: The HTTP status of this answer.
        code:
          type: string
          enum:
            - address_unavailable
            - agreement_required
            - api_offers_disabled
            - below_floor
            - cap_reached
            - client_limit
            - daily_cap_reached
            - deal_changed
            - deal_closed
            - deal_incomplete
            - designation_required
            - draft_under_review
            - duplicate_inquiry
            - forbidden
            - idempotency_conflict
            - idempotency_in_progress
            - idv_required
            - insufficient_balance
            - insufficient_role
            - insufficient_scope
            - invalid_body
            - invalid_id
            - invalid_parameter
            - invalid_transition
            - lead_locked
            - method_not_allowed
            - no_organization
            - not_a_member
            - not_found
            - offer_exists
            - offer_required
            - offer_superseded
            - organization_required
            - origin_error
            - person_exists
            - preview_expired
            - preview_mismatch
            - proof_of_funds_expired
            - proof_of_funds_missing
            - rate_limited
            - requirement_unmet
            - resource_exists
            - resource_limit
            - strike_exists
            - strike_window_closed
            - terms_required
            - unauthorized
            - unknown_parameter
            - validation_failed
            - webhook_limit
            - webhook_url_refused
            - wrong_side
          description: The problem code. Read this, never the title.
        detail:
          type: string
          description: What happened for this one request.
        recovery:
          type: string
          description: One sentence that says what to do next.
        request_id:
          type: string
          description: The id this answer shares with the log.
      required:
        - type
        - title
        - status
        - code
        - detail
        - recovery
        - request_id
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        Authorization code with PKCE. The person grants the scopes on the
        Investorlift consent page and accepts the Marketplace API Terms there.
      flows:
        authorizationCode:
          authorizationUrl: https://mogul.investorlift.com/api/auth/oauth2/authorize
          tokenUrl: https://mogul.investorlift.com/api/auth/oauth2/token
          refreshUrl: https://mogul.investorlift.com/api/auth/oauth2/token
          scopes:
            marketplace:profile: Read your account, your organization and your trust tier.
            deals:read: Read your deals as a seller, and the deals you see as a buyer.
            deals:write: >-
              Create drafts, add media and documents, publish deals and change
              their status.
            offers:read: >-
              Read the offers on your deals as a seller, and your own offers as
              a buyer.
            offers:write: Make, counter, accept, decline and withdraw offers.
            inquiries:read: >-
              Read the inquiries and address requests on your deals, and your
              own.
            inquiries:write: Send inquiries and address requests, and answer address requests.
            leads:read: Read the leads on your deals with their history.
            leads:write: Set a lead status, add a lead and file a strike.
            contacts:read: >-
              Read the email address and the phone number of a buyer on your
              deals.
            reviews:read: Read a seller public profile and the reviews of that seller.
            buy_boxes:manage: Read and change your buy boxes and their alerts.
            webhooks:manage: Create, read and delete the webhook endpoints of your side.
            events:read: Read the event feed of your side.

````

## Related topics

- [Read what this token can do](/marketplace/reference/get-marketplace-me.md)
- [The Marketplace API](/marketplace/overview.md)
- [Trust and limits](/marketplace/concepts/trust-and-limits.md)
- [Webhooks and events](/marketplace/concepts/webhooks-and-events.md)
- [Authentication](/marketplace/authentication.md)
