ImobyFlowParcerias Imobiliárias
Browse the documentation
Português

Account

The account that owns the key: plan, property quota, key permissions, limits and monthly usage.

Routes

GET/v1/me

Who am I

The first call of every integration: confirms the key works and shows the account, this key's permissions, the limits and monthly usage.

Permission: any valid key

Response200OK

dataMerequired
Account.

Example

curl -X GET 'https://api.imobyflow.com.br/v1/me' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: en'

Errors for this route

    And the errors common to every route

    Objects

    Limits

    The account's usage tier limits.

    ratePerSecondintegerrequired
    Calls per second.
    burstintegerrequired
    Short burst allowed.
    monthlyQuotaintegerrequired
    Calls per month (calendar month, UTC).
    maxKeysintegerrequired
    Active keys at the same time.
    maxWebhooksintegerrequired
    Webhook endpoints.

    Me

    Who the account is, what the key can do and how much of the quota is used.

    accountobjectrequired
    The account that owns the key.
    account.idstringrequired
    Account id.
    account.namestringrequirednullable
    Company name.
    account.typestringrequirednullable
    IMOBILIARIA (agency) or CONSTRUTORA (developer).
    account.planstringrequirednullable
    Plan code.
    accessobjectrequired
    API access.
    access.statusstringrequirednullable
    Access status (APPROVED when valid).
    access.tierstringrequired
    Usage tier: PADRAO (standard) or AMPLIADA (extended).
    access.pilotUntilstringrequirednullable
    End of the pilot period, if any.
    access.limitsLimitsrequired
    The limits that apply to the account.
    keyobjectrequired
    The key used in this call.
    key.idstringrequirednullable
    Key id (not the secret).
    key.namestringrequirednullable
    Name given in the dashboard.
    key.scopeslist of stringrequired
    The permissions that apply to THIS key.one of properties:read properties:write leads:read leads:write radar:read radar:write partnerships:read partnerships:write team:read launches:read launches:write captacao:read captacao:accept events:read webhooks:manage
    key.expiresAtstringrequirednullable
    When the key expires (null = no expiry).
    usageobjectrequired
    Monthly usage.
    usage.monthstringrequired
    The month (YYYY-MM, UTC).
    usage.callsintegerrequired
    Calls made this month.
    usage.monthlyQuotaintegerrequired
    The monthly quota.
    usage.remainingintegerrequired
    What is left.
    propertiesobjectrequired
    The plan's property quota.
    properties.activeintegerrequired
    Active properties right now.
    properties.limitintegerrequirednullable
    The plan's active-property cap.