転送元 - Freshsales
    • PDF

    転送元 - Freshsales

    • PDF

    記事の要約

    本ページでは、Freshsalesからデータを取得するための設定(転送設定)について説明します。
    接続に関する設定については、接続情報 - Freshsalesを参照ください。

    利用上の注意・制約

    API Rate Limit

    Freshsales APIには、APIキーの種類に応じたレート制限があります。制限を超えると、HTTP 429エラーが返され、一時的にAPIが使用できなくなります。詳細はFreshsales公式ドキュメント − Rate Limitsを参照ください。

    取得対象

    Contacts Views

    コンタクトのビュー(フィルター)一覧を取得します。
    詳しくは、Freshsales公式ドキュメント − Contacts Viewsを参照ください。

    設定項目

    設定項目はありません。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongビューの一意識別子
    namestringビュー名
    model_class_namestringモデルクラス名
    user_idlongユーザーの一意識別子
    is_defaultbooleanデフォルトビューかどうか
    updated_attimestamp更新日時
    user_namestringユーザー名
    current_user_permissionsjson現在のユーザーの権限情報

    Contacts

    指定したビューID内のコンタクト一覧を取得します。
    詳しくは、Freshsales公式ドキュメント − Contactsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    View ID-取得対象のビューIDを入力します。
    ビューIDは、コンタクトビューのURLまたは「Contacts Views」の取得データから確認できます。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongコンタクトの一意識別子
    first_namestring
    last_namestring
    display_namestring表示名
    emailstringメールアドレス
    work_numberstring勤務先電話番号
    mobile_numberstring携帯電話番号
    addressstring住所
    citystring市区町村
    statestring都道府県
    zipcodestring郵便番号
    countrystring
    job_titlestring職種
    lead_scorelongリードスコア
    deals_amountlong取引金額
    deals_countlong取引件数
    created_attimestamp作成日時
    updated_attimestamp更新日時
    last_contactedtimestamp最終接触日時
    last_seentimestamp最終確認日時
    facebookstringFacebook情報
    twitterstringTwitter情報
    linkedinstringLinkedIn情報
    subscription_statusstring購読状況
    tagsjsonタグ情報
    subscription_typesstring購読タイプ
    keywordstringキーワード
    mediumstring媒体
    campaign_idlongキャンペーンID
    lead_source_idlongリード元ID
    owner_idlong所有者ID
    sales_account_idlong営業アカウントID
    time_zonestringタイムゾーン
    external_idstring外部ID
    avatarstringアバター情報
    aboutstring概要
    linksjsonリンク情報
    collaborationjsonコラボレーション情報
    custom_fieldjsonカスタムフィールド情報
    lifecycle_stage_idlongライフサイクルステージID
    contact_status_idlongコンタクトステータスID
    whatsapp_subscription_statusstringWhatsApp購読状況
    sms_subscription_statusstringSMS購読状況
    record_type_idlongレコードタイプID
    do_not_disturbboolean連絡禁止フラグ
    recent_notestring最新メモ
    business_type_idlongビジネスタイプID
    ai_agent_scorelongAIエージェントスコア
    company_deals_amountlong会社取引金額
    company_deals_countlong会社取引件数
    company_namestring会社名
    company_idlong会社ID
    company_open_deals_amountlong会社進行中取引金額
    company_open_deals_countlong会社進行中取引件数
    company_won_deals_amountlong会社成約取引金額
    company_won_deals_countlong会社成約取引件数
    company_last_contactedtimestamp会社最終接触日時
    company_last_activity_datetimestamp会社最終活動日時
    company_last_modified_datetimestamp会社最終変更日時
    company_created_datetimestamp会社作成日時
    company_updated_datetimestamp会社更新日時
    contact_lifecycle_stage_idlongコンタクトライフサイクルステージID
    contact_lifecycle_stage_namestringコンタクトライフサイクルステージ名
    contact_lifecycle_stage_created_attimestampコンタクトライフサイクルステージ作成日時
    contact_lifecycle_stage_updated_attimestampコンタクトライフサイクルステージ更新日時
    contact_email_status_idlongコンタクトメールステータスID
    contact_email_status_namestringコンタクトメールステータス名
    contact_email_status_created_attimestampコンタクトメールステータス作成日時
    contact_email_status_updated_attimestampコンタクトメールステータス更新日時
    contact_status_namestringコンタクトステータス名
    contact_status_created_attimestampコンタクトステータス作成日時
    contact_status_updated_attimestampコンタクトステータス更新日時
    contact_record_type_idlongコンタクトレコードタイプID
    contact_record_type_namestringコンタクトレコードタイプ名
    contact_record_type_created_attimestampコンタクトレコードタイプ作成日時
    contact_record_type_updated_attimestampコンタクトレコードタイプ更新日時
    open_deals_amountlong進行中取引金額
    open_deals_countlong進行中取引件数
    won_deals_amountlong成約取引金額
    won_deals_countlong成約取引件数
    last_activity_datetimestamp最終活動日時
    last_modified_datetimestamp最終変更日時
    resource_typestringリソースタイプ

    Deals Views

    取引のビュー(フィルター)一覧を取得します。
    詳しくは、Freshsales公式ドキュメント − Deals Viewsを参照ください。

    設定項目

    設定項目はありません。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongビューの一意識別子
    namestringビュー名
    model_class_namestringモデルクラス名
    user_idlongユーザーの一意識別子
    is_defaultbooleanデフォルトビューかどうか
    updated_attimestamp更新日時
    user_namestringユーザー名
    current_user_permissionsjson現在のユーザーの権限情報

    Deals

    指定したビューID内の取引一覧を取得します。
    詳しくは、Freshsales公式ドキュメント − Dealsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    View ID-取得対象のビューIDを入力します。
    ビューIDは、取引ビューのURLまたは「Deals Views」の取得データから確認できます。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlong取引の一意識別子
    namestring取引名
    amountlong取引金額
    probabilitylong確度
    expected_closetimestamp予想成約日
    deal_pipeline_idlong取引パイプラインID
    deal_stage_idlong取引ステージID
    stage_updated_timetimestampステージ更新日時
    created_attimestamp作成日時
    updated_attimestamp更新日時
    closed_datetimestampクローズ日時
    agelong経過日数
    forecast_categorystring予測カテゴリー
    deal_predictionstring取引予測
    linksjsonリンク情報
    collaborationjsonコラボレーション情報
    tagsjsonタグ情報
    base_currency_amountlong基準通貨金額
    contacts_added_with_dealjson取引と一緒に追加されたコンタクト
    created_bylong作成者ID
    custom_fieldjsonカスタムフィールド情報
    deal_payment_statusstring取引支払いステータス
    deal_pipeline_namestring取引パイプライン名
    deal_reasonstring取引理由
    deal_source_idlong取引元ID
    deal_stage_namestring取引ステージ名
    deal_typestring取引タイプ
    expected_deal_valuelong予想取引価値
    last_activity_datetimestamp最終活動日時
    last_modified_datetimestamp最終変更日時
    lost_reasonstring失注理由
    next_activity_datetimestamp次回活動日時
    owner_idlong所有者ID
    recent_notestring最新メモ
    rotten_dayslong停滞日数
    sales_account_idlong営業アカウントID
    sales_account_namestring営業アカウント名
    updated_bylong更新者ID
    won_timetimestamp成約日時
    resource_typestringリソースタイプ

    Accounts Views

    アカウントのビュー(フィルター)一覧を取得します。
    詳しくは、Freshsales公式ドキュメント − Accounts Viewsを参照ください。

    設定項目

    設定項目はありません。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongビューの一意識別子
    namestringビュー名
    model_class_namestringモデルクラス名
    user_idlongユーザーの一意識別子
    is_defaultbooleanデフォルトビューかどうか
    updated_attimestamp更新日時
    user_namestringユーザー名
    current_user_permissionsjson現在のユーザーの権限情報

    Accounts

    指定したビューID内のアカウント一覧を取得します。
    詳しくは、Freshsales公式ドキュメント − Accountsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    View ID-取得対象のビューIDを入力します。
    ビューIDは、アカウントビューのURLまたは「Accounts Views」の取得データから確認できます。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongアカウントの一意識別子
    namestringアカウント名
    addressstring住所
    citystring市区町村
    statestring都道府県
    countrystring
    number_of_employeeslong従業員数
    annual_revenuelong年間売上
    websitestringウェブサイト
    open_deals_amountlong進行中取引金額
    won_deals_amountlong成約取引金額
    deals_countlong取引件数
    created_attimestamp作成日時
    updated_attimestamp更新日時
    last_contactedtimestamp最終接触日時
    health_scorelongヘルススコア
    account_tierstringアカウントティア
    renewal_datetimestamp更新日
    zipcodestring郵便番号
    phonestring電話番号
    owner_idlong所有者ID
    facebookstringFacebook情報
    twitterstringTwitter情報
    linkedinstringLinkedIn情報
    aboutstring概要
    linksjsonリンク情報
    collaborationjsonコラボレーション情報
    tagsjsonタグ情報
    parent_sales_account_idlong親営業アカウントID
    custom_fieldjsonカスタムフィールド情報
    industry_type_idlong業界タイプID
    business_type_idlongビジネスタイプID
    territory_idlongテリトリーID
    record_type_idlongレコードタイプID
    avatarstringアバター情報
    external_idstring外部ID
    recent_notestring最新メモ
    avatar_urlstringアバターURL
    subscription_statusstring購読状況
    subscription_typesstring購読タイプ
    whatsapp_subscription_statusstringWhatsApp購読状況
    sms_subscription_statusstringSMS購読状況
    last_activity_datetimestamp最終活動日時
    last_modified_datetimestamp最終変更日時
    business_type_namestringビジネスタイプ名
    business_type_created_attimestampビジネスタイプ作成日時
    business_type_updated_attimestampビジネスタイプ更新日時
    industry_type_namestring業界タイプ名
    industry_type_created_attimestamp業界タイプ作成日時
    industry_type_updated_attimestamp業界タイプ更新日時
    territory_namestringテリトリー名
    territory_created_attimestampテリトリー作成日時
    territory_updated_attimestampテリトリー更新日時
    record_type_namestringレコードタイプ名
    record_type_created_attimestampレコードタイプ作成日時
    record_type_updated_attimestampレコードタイプ更新日時
    resource_typestringリソースタイプ

    この記事は役に立ちましたか?