Skip to content
Migrating from NextAuth.js v4? Read our migration guide.
API reference
pipedrive

providers/pipedrive

Built-in Pipedrive integration.

PipedriveProfile

Extends

  • Record<string, any>

Properties

data

data: {
  activated: boolean;
  active_flag: boolean;
  company_country: string;
  company_domain: string;
  company_id: number;
  company_industry: string;
  company_name: string;
  created: Date;
  default_currency: string;
  email: string;
  has_created_company: boolean;
  icon_url: string;
  id: number;
  is_admin: number;
  is_you: boolean;
  lang: number;
  language: {
     country_code: string;
     language_code: string;
  };
  last_login: Date;
  locale: string;
  modified: Date;
  name: string;
  phone: string;
  role_id: number;
  signup_flow_variation: string;
  timezone_name: string;
  timezone_offset: string;
};
activated?
optional activated: boolean;
active_flag?
optional active_flag: boolean;
company_country?
optional company_country: string;
company_domain?
optional company_domain: string;
company_id?
optional company_id: number;
company_industry?
optional company_industry: string;
company_name?
optional company_name: string;
created?
optional created: Date;
default_currency?
optional default_currency: string;
email
email: string;
has_created_company?
optional has_created_company: boolean;
icon_url?
optional icon_url: string;
id
id: number;
is_admin?
optional is_admin: number;
is_you?
optional is_you: boolean;
lang?
optional lang: number;
language?
optional language: {
  country_code: string;
  language_code: string;
};
language.country_code?
optional country_code: string;
language.language_code?
optional language_code: string;
last_login?
optional last_login: Date;
locale?
optional locale: string;
modified?
optional modified: Date;
name
name: string;
phone?
optional phone: string;
role_id?
optional role_id: number;
signup_flow_variation?
optional signup_flow_variation: string;
timezone_name?
optional timezone_name: string;
timezone_offset?
optional timezone_offset: string;

success

success: boolean;

default()

default<P>(options): OAuthConfig<P>

Add Pipedrive login to your page.

Setup

Callback URL

https://example.com/api/auth/callback/pipedrive

Configuration

import { Auth } from "@auth/core"
import Pipedrive from "@auth/core/providers/pipedrive"
 
const request = new Request(origin)
const response = await Auth(request, {
  providers: [
    Pipedrive({
      clientId: PIPEDRIVE_CLIENT_ID,
      clientSecret: PIPEDRIVE_CLIENT_SECRET,
    }),
  ],
})

Resources

Notes

By default, Auth.js assumes that the Pipedrive provider is based on the OAuth 2 specification.

💡

The Pipedrive provider comes with a default configuration. To override the defaults for your use case, check out customizing a built-in OAuth provider.

Disclaimer If you think you found a bug in the default configuration, you can open an issue.

Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec, we might not pursue a resolution. You can ask for more help in Discussions.

Type parameters

Type parameter
P extends PipedriveProfile

Parameters

ParameterType
optionsOAuthUserConfig<P>

Returns

OAuthConfig<P>

Auth.js © Balázs Orbán and Team - 2024