Search and list contacts in Ploomes CRM. Supports OData filtering, sorting, field selection, and pagination.

Available $expand values: Type, Company, Tags, OtherProperties, InteractionRecords, Attachments, Documents, Products, Contacts.

$filter examples:

• Exact match: "Name eq 'João Silva'"

• Contains text: "contains(Name, 'Silva')"

• Starts with: "startswith(Email, 'joao')"

• By status: "StatusId eq 1"

• By type: "TypeId eq 2"

• Date filter: "CreateDate ge 2025-01-01T00:00:00Z"

• Custom field: "OtherProperties/any(o: o/FieldId eq 12345 and o/StringValue eq 'valor')"

• Combined: "TypeId eq 1 and contains(Name, 'Silva') and StatusId eq 1"

Use ploomes_contacts_types_list to discover valid TypeId values. Use ploomes_contacts_status_list to discover valid StatusId values. Use ploomes_contacts_origins_list to discover valid OriginId values.

Get a single contact by ID from Ploomes CRM.

Available $expand values: Type, Company, Tags, OtherProperties, InteractionRecords, Attachments, Documents, Products, Contacts.

Use $expand=OtherProperties to include custom field values. Use $expand=Tags to see associated tags. Use $expand=InteractionRecords to see interaction history. Use $expand=Company to see the parent company details.

Create a new contact in Ploomes CRM. Name is required. Use OtherProperties to set custom fields.

To find valid IDs for reference fields:

• TypeId: use ploomes_contacts_types_list (typically 1=Person, 2=Company, but may vary per account)

• StatusId: use ploomes_contacts_status_list to discover available contact statuses

• OriginId: use ploomes_contacts_origins_list to discover available contact origins

• OwnerId: use ploomes_users_list to discover valid user IDs

• CityId: numeric city ID from the Ploomes cities database

• CurrencyId: numeric currency ID from the Ploomes currencies list

Update an existing contact in Ploomes CRM by ID. Only provided fields are changed; omitted fields remain untouched.

To find valid IDs for reference fields:

• TypeId: use ploomes_contacts_types_list (typically 1=Person, 2=Company, but may vary per account)

• StatusId: use ploomes_contacts_status_list to discover available contact statuses

• OriginId: use ploomes_contacts_origins_list to discover available contact origins

• OwnerId: use ploomes_users_list to discover valid user IDs

• CityId: numeric city ID from the Ploomes cities database

• CurrencyId: numeric currency ID from the Ploomes currencies list

Delete a contact from Ploomes CRM by ID. This action is irreversible.

Search and list deals (opportunities) in Ploomes CRM. Supports OData filtering, sorting, field selection, and pagination. Common filters: ContactId eq 123, StageId eq 456, StatusId eq 1, OwnerId eq 789, Amount gt 1000. StatusId values: typically 1=Open, 2=Won, 3=Lost — use ploomes_deals_status_list to confirm the exact mapping for your account. Use ploomes_stages_list to find valid StageId values. Use ploomes_users_list to find valid OwnerId values. Available $expand options: Contact, Person, Stage, Status, Tags, Tasks, Products, Quotes, Origin, InteractionRecords, Orders, OtherProperties, Documents.

Get a single deal by ID from Ploomes CRM. Use $expand to include related entities. Available $expand options: Contact, Person, Stage, Status, Tags, Tasks, Products, Quotes, Origin, InteractionRecords, Orders, OtherProperties, Documents.

Create a new deal (opportunity) in Ploomes CRM. Title is required. ContactId and PersonId both reference entities from /Contacts but serve different roles: ContactId = the company/organization contact associated with the deal; PersonId = the individual person contact linked to the deal (often an employee of the company). StageId determines which pipeline stage the deal starts in — use ploomes_pipelines_list to find pipelines, then ploomes_stages_list to find valid stage IDs within a pipeline. If StageId is omitted, the deal defaults to the first stage of the first active pipeline. DealNumber is read-only and auto-generated by Ploomes — do not set it. Use ploomes_currencies_list to find valid CurrencyId values. Use ploomes_contacts_origins_list to find valid OriginId values. Use OtherProperties to set custom fields (call ploomes_fields_list to discover available field keys).

Update an existing deal in Ploomes CRM. Only provided fields are changed. Use StageId to move a deal between stages within the same pipeline or to a different pipeline — use ploomes_pipelines_list then ploomes_stages_list to find valid stage IDs. ContactId and PersonId both reference /Contacts but serve different roles: ContactId = company/organization, PersonId = individual person. DealNumber is read-only and auto-generated — do not set it. Use OtherProperties to update custom fields.

Delete a deal from Ploomes CRM by ID. This action is irreversible.

Mark a deal as won in Ploomes CRM. Sets the deal StatusId to 2 (Won). The deal's pipeline must have MayWinDeals=true for this action to succeed — use ploomes_pipelines_list to check. Only open deals (StatusId=1) can be won. Sends an empty body to POST /Deals({Id})/Win.

Mark a deal as lost in Ploomes CRM. Sets the deal StatusId to 3 (Lost). Requires a LossReasonId — use ploomes_deals_loss_reasons_list to find valid loss reason IDs for your account. Only open deals (StatusId=1) can be marked as lost.

Reopen a previously won or lost deal in Ploomes CRM. The deal returns to its last stage before being won/lost, and its StatusId goes back to 1 (Open). Only deals with StatusId=2 (Won) or StatusId=3 (Lost) can be reopened. Sends an empty body to POST /Deals({Id})/Reopen.

Search and list tasks in Ploomes CRM. Supports OData filtering, sorting, field selection, and pagination. Filter by DealId, ContactId, OwnerId, TypeId, Finished status, Date range, and more. Available $expand options: Type, Contact, Deal, Owner, Users, Tags, Comments, InteractionRecord, InteractionRecords, Creator, OtherProperties, Attachments.

Get a single task by ID from Ploomes CRM. Use $expand to include related entities. Available $expand options: Type, Contact, Deal, Owner, Users, Tags, Comments, InteractionRecord, InteractionRecords, Creator, OtherProperties, Attachments.

Create a new task in Ploomes CRM. Attach to a deal via DealId or to a contact via ContactId. Date and Hour are separate fields: Date is the due date (ISO 8601), Hour is the time component as a string (e.g., '14:30'). Use OtherProperties to set custom fields.

Update an existing task in Ploomes CRM by ID. Only provided fields are changed. Date and Hour are separate fields: Date is the due date (ISO 8601), Hour is the time component as a string (e.g., '14:30').

Delete a task from Ploomes CRM by ID. This action is irreversible.

Mark a task as finished (completed) in Ploomes CRM. Sends {Finished: true} to the API. This is an idempotent action — finishing an already-finished task has no adverse effect.

List all sales pipelines (funnels) in Ploomes CRM. Pipelines contain stages that deals move through. Each pipeline has configuration flags that control deal behavior: MustPassAllStages (deals must go through every stage in order), ForbiddenStageReturn (deals cannot move back to a previous stage), MayWinDeals (deals in this pipeline can be won), MayLoseDeals (deals in this pipeline can be lost), WinDealOnLastStage (deals are automatically won when moved to the last stage), MayCreateQuotes (quotes can be created for deals in this pipeline), MayCreateOrders (orders can be created for deals in this pipeline). Use $select to get specific fields. Key fields: Id, Name, Ordination, Archived, MustPassAllStages, ForbiddenStageReturn, MayCreateQuotes, MayCreateOrders, MayWinDeals, MayLoseDeals, WinDealOnLastStage.

List pipeline stages in Ploomes CRM. Stages define the sequential steps within a pipeline that deals progress through. Key fields: Id, Name, PipelineId, Ordination. The Ordination field determines the order of stages within a pipeline — use orderby='Ordination asc' to get stages in their correct sequence. Always filter by PipelineId to get stages for a specific pipeline. Use ploomes_pipelines_list first to discover available PipelineId values.

Search and list interaction records (notes, emails, activities) in Ploomes CRM. Supports OData filtering, sorting, field selection, and pagination. Full $expand options: Contact, Deal, Tags, Comments, NotifiedUsers, OtherProperties.

Get a single interaction record by ID from Ploomes CRM. Use $expand to include related entities like Contact, Deal, Tags, Comments, NotifiedUsers, or OtherProperties.

Create a new interaction record (note, email, activity) in Ploomes CRM. Attach to a deal and/or contact. If DealId is provided, ContactId is auto-filled from the deal when omitted.

Update an existing interaction record in Ploomes CRM. Only provided fields are changed.

Delete an interaction record from Ploomes CRM by ID.

List custom fields configured in Ploomes CRM. Filter by EntityId to get fields for a specific entity. Known EntityId values: 1=Contact, 2=Deal, 4=Order, 7=Quote, 10=Product, 12=Task, 36=Interaction Record. Use ploomes_fields_entities_list for the complete mapping. Each field has a Key (used in OtherProperties when reading/writing custom field values), Name, and TypeId. Use ploomes_fields_types_list to understand which value property to use for each field type (e.g., StringValue, IntegerValue, DateTimeValue, BoolValue, BigStringValue, ObjectValueName). Use $expand=Entity,Type,OptionsTable to include related info.

List users in the Ploomes CRM account. Returns Id, Name, Email, AvatarUrl, RoleId, ProfileId, Phone, etc. Use the returned Id as OwnerId when creating or assigning contacts, deals, tasks, and interaction records. Use $expand=Role,Profile,Teams,OtherProperties to include related data.

Get information about the current Ploomes CRM account including company Name, Email, Phone, Website, Register (CNPJ), CityId, StreetAddress, and plan details. Use $expand=OtherProperties,Plan to include custom fields and plan info.

Search and list quotes (proposals) in Ploomes CRM. Supports OData filtering, sorting, field selection, and pagination. Use $expand=OtherProperties to include custom fields.

Get a single quote (proposal) by ID from Ploomes CRM. Use $expand to include related entities like OtherProperties, Products, Pages, or Comments.

Create a new quote (proposal) in Ploomes CRM. DealId is required. The QuoteNumber is auto-generated (read-only).

Update an existing quote in Ploomes CRM by ID. Only provided fields are changed. The QuoteNumber is read-only and cannot be updated.

Delete a quote from Ploomes CRM by ID.

Search and list orders in Ploomes CRM. Supports OData filtering, sorting, field selection, and pagination. Use $expand=OtherProperties to include custom fields.

Get a single order by ID from Ploomes CRM. Use $expand to include related entities like OtherProperties, Products, or Attachments.

Create a new order in Ploomes CRM. ContactId is required.

Update an existing order in Ploomes CRM by ID. Only provided fields are changed.

Delete an order from Ploomes CRM by ID.

Search and list products in Ploomes CRM. Use to find product IDs for deals and quotes. Supports OData filtering, sorting, field selection, and pagination. Use $expand=OtherProperties to include custom fields.

Get a single product by ID from Ploomes CRM. Use $expand to include related entities like OtherProperties, Group, Family, or Parts.

Create a new product in Ploomes CRM. Name is required.

Update an existing product in Ploomes CRM by ID. Only provided fields are changed.

Delete a product from Ploomes CRM by ID.

List available contact types in Ploomes CRM (e.g., Pessoa/Person, Empresa/Company). Returns Id and Name for each type. Use the returned Id as TypeId when creating or filtering contacts.

List available contact statuses in Ploomes CRM (e.g., Ativo/Active, Inativo/Inactive). Returns Id and Name. Use the returned Id as StatusId when creating or filtering contacts.

List available contact/lead origins in Ploomes CRM (e.g., Website, Referral, Cold Call). Returns Id and Name. Use the returned Id as OriginId when creating contacts or deals.

List available deal statuses in Ploomes CRM. Typically: 1=Open (Aberto), 2=Won (Ganho), 3=Lost (Perdido). Returns Id and Name. Use in $filter expressions like 'StatusId eq 1' to find open deals.

List available loss reasons for deals in Ploomes CRM. Returns Id and Name. You MUST provide a valid LossReasonId when calling ploomes_deals_lose. Loss reasons may be filtered by PipelineId.

List available task types in Ploomes CRM (e.g., Ligação/Call, Reunião/Meeting, E-mail, Visita/Visit). Returns Id, Name, Icon, Color. Use the returned Id as TypeId when creating tasks or interaction records.

List available currencies in Ploomes CRM (e.g., BRL, USD, EUR). Returns Id, Symbol, Name, etc. Use the returned Id as CurrencyId when creating deals, orders, or products.

List entity types that support custom fields in Ploomes CRM. Returns Id and Name. Known EntityId values: 1=Contact, 2=Deal, 4=Order, 5=Order Section, 7=Quote, 8=Quote Section, 10=Product, 12=Task, 14=Quote Product, 20=Order Product, 36=Interaction Record. Use these when filtering ploomes_fields_list.

List available custom field types in Ploomes CRM. Returns Id, Name, NativeType. The NativeType tells you which value property to use in OtherProperties: String→StringValue, Integer→IntegerValue, Boolean→BoolValue, DateTime→DateTimeValue, Decimal→BigStringValue, Object (dropdown)→ObjectValueName.

List options tables (dropdown value sets) for custom fields in Ploomes CRM. Each table contains the valid options for a dropdown-type custom field. Use ploomes_fields_options_list to see the options within a table.

List individual options within a dropdown-type custom field in Ploomes CRM. Filter by OptionsTableId to get options for a specific dropdown field. Returns Id and Name for each option. Use the Name as ObjectValueName when writing OtherProperties.

List available order stages in Ploomes CRM. Returns Id and Name. Use the returned Id as StageId when creating or updating orders.