View Source API Reference ex_pipedrive v0.2.0
Modules
Convenience entrypoint for ExPipedrive.
Pipedrive activities resource.
Activity entity decoded from Pipedrive API v1 or v2 responses.
API v2 activity field definitions.
Activity participant decoded from Pipedrive API v1 or v2 responses.
An activity type in Pipedrive (/api/v1/activityTypes).
API v1 client for Pipedrive activity types.
This module and enclosed structs represent additional metadata in response data from pipedrive.
This module and enclosed structs represent a call log in pipedrive.
API v1 client for Pipedrive call logs.
Builds authenticated Tesla clients for the Pipedrive API.
API v1 client for Pipedrive currencies.
A supported currency in a Pipedrive account.
Cursor pagination helpers for Pipedrive API v2.
Deal entity decoded from Pipedrive API v1 or v2 responses.
API v2 deal field definitions.
A scheduled payment entry on a deal (/api/v2/deals/installments).
Pipedrive deal-installments resource — scheduled payment entries on deals.
Deal label definitions via the system label_ids field.
A person participating in a deal, from /api/v1/deals/:id/participants.
API v1 shim for Pipedrive deal participants.
A product attachment on a deal (/api/v2/deals/:id/products).
Pipedrive deal-products resource — products attached to a deal.
Pipedrive deals resource.
Normalized error returned by ExPipedrive public APIs as {:error, %ExPipedrive.Error{}}.
A Pipedrive field definition.
This is a custom field option for person, org, and other custom fields in pipedrive's API
Resolves Pipedrive custom-field hashes and human-readable labels.
Metadata for a Pipedrive file (attachment).
API v1 client for Pipedrive files (attachments).
This module and enclosed structs represent a filter in pipedrive.
API v1 client for Pipedrive filters.
A user following a deal, person, or organization.
API v2 client for followers on deals, persons, and organizations.
This module and enclosed structs represent a sales goal in Pipedrive.
API v1 client for Pipedrive goals.
A Pipedrive label.
Facade over Pipedrive label definitions for deals, persons, organizations, and leads.
This module and enclosed structs represent a lead in pipedrive.
API v1 lead field definitions.
API v1 shim for Pipedrive lead labels.
This module represent a lead organization in pipedrive.
This module represent a lead person in pipedrive.
A fixed lead source name from Pipedrive's /api/v1/leadSources list.
API v1 client for Pipedrive lead sources.
Represents a lead value in Pipedrive.
API v1 shim for Pipedrive leads.
A single email inside a Pipedrive mail thread.
A single sender/recipient entry on a ExPipedrive.MailMessage
(:from, :to, :cc, or :bcc).
A Pipedrive mailbox thread (a group of related mail messages).
API v1 client for the Pipedrive Mailbox (mail threads and messages).
Retries retriable Pipedrive HTTP failures with backoff.
Emits :telemetry events for ExPipedrive HTTP requests.
This module and enclosed structs represent a note in pipedrive.
API v1 client for Pipedrive note field definitions.
API v1 shim for Pipedrive notes.
Pipedrive OAuth helpers: authorize URL, code exchange, and token refresh.
OAuth token bundle from Pipedrive's token endpoint.
Behaviour for persisting OAuth token bundles.
In-memory TokenStore backed by a public ETS table.
Organization entity decoded from Pipedrive API v1 or v2 responses.
API v2 organization field definitions.
Organization label definitions via the system label_ids field.
A relationship between two organizations, from /api/v1/organizationRelationships.
API v1 client for Pipedrive organization relationships.
Pipedrive organizations resource.
A single cursor-paginated page of Pipedrive API v2 results.
Offset-paginated response wrapper for Pipedrive API v1 list endpoints.
This module and enclosed structs represent pagination metadatafrom pipedrive.
A Pipedrive permission set (/api/v1/permissionSets).
API v1 client for Pipedrive permission sets.
Person entity decoded from Pipedrive API v1 or v2 responses.
API v2 person field definitions.
Person label definitions via the system label_ids field.
Pipedrive persons resource.
Pipeline entity decoded from Pipedrive API v1 or v2 responses.
Pipedrive pipelines resource.
Product entity decoded from Pipedrive API v2 responses.
API v2 product field definitions.
Product variation entity decoded from Pipedrive API v2 responses.
Pipedrive product variations resource — nested under a product id.
Pipedrive products resource.
Project entity decoded from Pipedrive API v2 responses.
Project board entity decoded from Pipedrive API v2 responses.
Pipedrive project boards resource — workflow containers for projects.
Pipedrive projects resource — work items spanning deals, activities, and tasks.
Parses Pipedrive rate-limit response headers.
Escape hatch for Pipedrive endpoints without a first-class module.
A recent-change entry from GET /api/v1/recents.
API v1 client for Pipedrive recent changes.
Versioned Pipedrive API request helpers.
Behaviour and HTTP helpers for Pipedrive resource modules.
Maps Tesla results into {:ok, value} / {:error, %ExPipedrive.Error{}}.
A Pipedrive visibility-group role (/api/v1/roles).
A user assignment on a Pipedrive role.
API v1 client for Pipedrive roles (visibility groups).
Pipedrive item search (API v2).
One hit from Pipedrive GET /api/v2/itemSearch.
Stage entity decoded from Pipedrive API v2 responses.
Pipedrive stages resource.
Helpers for building entity structs from Pipedrive JSON maps.
A project task decoded from Pipedrive API v2 /api/v2/tasks responses.
Pipedrive tasks resource — action items associated with projects.
A Pipedrive legacy team (/api/v1/legacyTeams).
API v1 client for Pipedrive legacy teams.
This module represents a user in pipedrive.
API v1 shim for Pipedrive users.
A normalized Pipedrive webhook event.
Behaviour for consuming normalized Pipedrive webhook events.
Manages outgoing Pipedrive webhook subscriptions through API v1.
A Pipedrive webhook subscription returned by the API v1 Webhooks endpoints.
Normalizes write payloads for Pipedrive create/update calls.