Me

The authenticated caller's identity and team affiliations. Returned from GET /api/v1/auth/me.

  • capabilities
    Type: object
    required
            The caller's status against each public-facing capability the platform recognises.
            Keys are the capability names (`broker`, `investor`); a key is present
            only when the caller currently holds a non-revoked claim on that capability.
            Absence means "no claim" — clients must do a key-presence check before reading
            the value. Values:
            * "active" — caller is admin-verified for this capability and may use
                the capability's full surface (broker authoring, investor teaser access, etc.).
    
    • "pending" — caller has requested verification but the review team hasn't approved yet. Onboarding-helper surfaces (mandate CRUD, business-card editor) remain reachable; capability-gated surfaces do not.
    • propertyName
      Type: string
  • culture
    Type: string
    required

    BCP-47 culture tag, e.g. "sv-SE".

  • emailConfirmed
    Type: boolean
    required

    true when the caller's primary email address has been verified. Use to decide whether to prompt the user to verify (e.g. via the navigate propstreet://verify_email/{email} flow) before granting email-gated features.

  • id
    Type: string
    required

    Opaque user identifier.

  • phoneConfirmed
    Type: boolean
    required

    true when the caller's primary phone number has been verified. Use to decide whether to prompt the user to verify (e.g. via the navigate propstreet://verify_phone/{phone} flow) before granting phone-gated features.

  • region
    Type: string
    required

    ISO 3166-1 alpha-2 country / region code.

  • timeZone
    Type: string
    required

    IANA time-zone identifier, e.g. "Europe/Stockholm".

  • uiCulture
    Type: string
    required

    BCP-47 UI culture tag, e.g. "sv-SE".

  • email
    Type: null | string

    Primary email address.

  • firstName
    Type: null | string

    Given name.

  • isBot
    Type: boolean

    true for automated service accounts. Omitted entirely for human users. Treat absence as false.

  • lastName
    Type: null | string

    Family name.

  • phone
    Type: null | string

    Primary phone number.

  • primaryTeam
    Type: object · Team nullable

    The caller's primary team. null if the caller has no active team.

    • categories
      Type: array string[]
      required

      Investment-profile categories. Any combination of institutional, public, private, unlisted, family, private_equity, investment_trust, construction, property_developer, residential_developer, investment, asset_management, foundation. Empty when none apply.

    • createdUtc
      Type: stringFormat: date-time
      required

      UTC timestamp at which the team was created.

    • id
      Type: string
      required

      Opaque team identifier.

    • membership
      Type: object · CallerMembership
      required

      The caller's membership in this team.

    • name
      Type: string
      required

      Display name of the team.

    • plan
      Type: string
      required

      Subscription plan: free, professional, or plus.

    • contactPerson
      Type: object · TeamContactPersonSummary nullable

      Designated contact person for the team.

    • country
      Type: null | string

      ISO 3166-1 alpha-2 country code of the team's primary address.

    • description
      Type: null | string

      Free-text description of the team.

    • hasMoreMembers
      Type: null | boolean

      true when there are more active members than fit in the inline members array. Page through GET /api/v1/teams/{id}/members to get the rest.

    • homepageUrl
      Type: null | string

      Public homepage URL.

    • investmentCapacity
      Type: object · PriceRange nullable

      Self-reported preferred ticket size per investment.

    • leasableArea
      Type: object · AreaRange nullable

      Self-reported preferred leasable area in square metres.

    • legalName
      Type: null | string

      Registered legal name, when different from the display name.

    • memberCount
      Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Total number of active members. Omitted for callers with a pending invite.

    • members
      Type: array object[] | null · TeamMember[]

      Active members of the team. Ordered with admins first, then by display name. Capped at 50 entries; call GET /api/v1/teams/{id}/members to page through larger rosters. Omitted for callers with a pending invite.

      A member of a team. Returned only to callers with an active membership in the same team.

    • profilePictureUrl
      Type: null | string

      Absolute URL to the team's logo image.

    • propertyCount
      Type: object · UnitRange nullable

      Self-reported preferred number of properties per deal.

    • propertyValue
      Type: object · PriceRange nullable

      Self-reported preferred property-value range.

    • restrictedInvestmentSize
      Type: object · PriceRange nullable

      Self-reported hard cap on the size of a single deal.

    • strategy
      Type: null | string

      Self-reported investment thesis. Free-form text.

    • vatNumber
      Type: null | string

      VAT or tax registration number.

  • profilePictureUrl
    Type: null | string

    Absolute URL to the caller's avatar image.

  • secondaryTeams
    Type: array object[] | null · Team[]

    Other teams the caller belongs to. Each entry's membership.status indicates whether it's an active membership or a pending invite. Omitted when the caller has no secondary teams — treat absence as "the caller has only their primary team".

    A team the caller belongs to or has been invited to. Returned from GET /api/v1/auth/me and GET /api/v1/teams/{id}.

    • categories
      Type: array string[]
      required

      Investment-profile categories. Any combination of institutional, public, private, unlisted, family, private_equity, investment_trust, construction, property_developer, residential_developer, investment, asset_management, foundation. Empty when none apply.

    • createdUtc
      Type: stringFormat: date-time
      required

      UTC timestamp at which the team was created.

    • id
      Type: string
      required

      Opaque team identifier.

    • membership
      Type: object · CallerMembership
      required

      The caller's membership in this team.

    • name
      Type: string
      required

      Display name of the team.

    • plan
      Type: string
      required

      Subscription plan: free, professional, or plus.

    • contactPerson
      Type: object · TeamContactPersonSummary nullable

      Designated contact person for the team.

    • country
      Type: null | string

      ISO 3166-1 alpha-2 country code of the team's primary address.

    • description
      Type: null | string

      Free-text description of the team.

    • hasMoreMembers
      Type: null | boolean

      true when there are more active members than fit in the inline members array. Page through GET /api/v1/teams/{id}/members to get the rest.

    • homepageUrl
      Type: null | string

      Public homepage URL.

    • investmentCapacity
      Type: object · PriceRange nullable

      Self-reported preferred ticket size per investment.

    • leasableArea
      Type: object · AreaRange nullable

      Self-reported preferred leasable area in square metres.

    • legalName
      Type: null | string

      Registered legal name, when different from the display name.

    • memberCount
      Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Total number of active members. Omitted for callers with a pending invite.

    • members
      Type: array object[] | null · TeamMember[]

      Active members of the team. Ordered with admins first, then by display name. Capped at 50 entries; call GET /api/v1/teams/{id}/members to page through larger rosters. Omitted for callers with a pending invite.

      A member of a team. Returned only to callers with an active membership in the same team.

    • profilePictureUrl
      Type: null | string

      Absolute URL to the team's logo image.

    • propertyCount
      Type: object · UnitRange nullable

      Self-reported preferred number of properties per deal.

    • propertyValue
      Type: object · PriceRange nullable

      Self-reported preferred property-value range.

    • restrictedInvestmentSize
      Type: object · PriceRange nullable

      Self-reported hard cap on the size of a single deal.

    • strategy
      Type: null | string

      Self-reported investment thesis. Free-form text.

    • vatNumber
      Type: null | string

      VAT or tax registration number.