With the Papo REST API, you can list, search, create, update, and link contacts to CRM Companies — all through authenticated requests, without opening the panel. It's the programmatic way to keep B2B client management synchronized with external systems, ERPs, CRMs, or automation tools.
Papo's API exposes resources from the Companies module so your operation can organize B2B accounts, consolidate linked contacts, and track recent conversations for each company. With secret key authentication and JSON responses, these endpoints allow you to integrate the account view into scripts, automations, and white label resellers.
Summary of Companies operations via API
| Operation | What it does | When to use |
|---|---|---|
| List companies | Returns the companies registered in the CRM with name, domain, and number of contacts. | Audit the account base or synchronize companies with another system. |
| Search by name or domain | Locates specific companies in the CRM. | Find the B2B account before updating data or linking contacts. |
| Get company details | Returns the data of a company by its identifier. | Consult a specific account during an integration. |
| Create company | Creates a new company; name is required, while domain and description are optional. | Register B2B accounts automatically from an ERP, website, or external flow. |
| Update company | Updates the name, domain, and description of an existing company. | Keep the CRM always aligned with the B2B client base. |
| Link contact | Links an existing CRM contact to a company. | Consolidate the relationship and history between contacts and accounts. |
| List contacts and conversations | Brings the contacts linked to the company and the recent conversations of those contacts. | Have a complete view of the account during service or follow-up. |
How API authentication works
All write routes, including Companies operations, require the account's secret key. It must be sent as a Bearer token. The account's public key is optional, but if sent, it must correspond to the same account as the secret key.
The API base URL is https://app.papo.global/api/v1. Keys are generated in the developer area of the Papo panel. The secret key appears only once upon creation; store it in a safe place and revoke it if there is any suspicion of leakage.
Since the API is REST and uses JSON, any language with HTTP support can be used to integrate Companies into scripts, ERPs, CRMs, or automation tools. The official documentation at https://papo.global/pt/docs provides details on authentication, parameters, responses, and code examples.
How to manage Companies via API in practice
- Access the developer area of the Papo panel and generate a secret key. Also copy the account's public key.
- In each request, authenticate with the secret key as a Bearer token. If you want to reinforce validation, send the public key in the header indicated in the documentation.
- To list the CRM companies, call the Companies listing endpoint. The response brings the name, domain, and number of contacts for each account.
- To locate a specific company, use the search by name or domain endpoint. This way you get the identifier needed to update data or link contacts.
- To create a company, send a JSON payload with the required name. Domain and description can be included as optional data.
- To update a company, send the new values for name, domain, or description in the update endpoint.
- To link an existing contact, use the contact identifier and the company identifier in the link operation.
Since the API processes one operation per request, bulk management is done by executing calls in sequence. A script in Python, Node.js, or an automation in tools like n8n can read accounts from a CSV or ERP, register companies, link contacts, and collect responses for error handling.
Who this integration makes sense for
- B2B companies that keep accounts in another CRM or ERP and want to automatically synchronize with Papo's Companies module.
- Sales teams that work with account clients, such as agencies, consultancies, SaaS, and providers, and need to consolidate contacts and conversations by company.
- Operations that capture companies from forms, landing pages, or external systems and want to create them in the CRM without manual rework.
- White label resellers and integrators who connect Papo to client systems and want to keep account management consistent across different environments.
- IT teams that build custom integrations using the API as a bridge between the company base and the rest of the operation.
Frequently asked questions
Do I need to create the contact before linking it to a Company?
Yes. The API links a contact that already exists in the CRM. To register a new contact, use the contact creation endpoints and then link it to the company.
What data can I update in a Company via API?
You can update the company's name, domain, and description. Creation requires the name; domain and description are optional.
Does the API allow listing a Company's conversations?
Yes. The Companies module allows listing the contacts linked to a company and the recent conversations of those contacts, facilitating the account view during service.
Is the authentication the same as used in other Papo endpoints?
Yes. Write routes require the account's secret key, sent as a Bearer token. The public key is optional and, if sent, must correspond to the same account.
Where can I find the exact paths and payload format?
In the official API documentation, available at https://papo.global/pt/docs. There you will find details on authentication, parameters, responses, and code examples for Companies and other resources.
Can I use the API to synchronize the Companies base with my current CRM?
Yes. Since the API is REST and uses JSON, you can automate listing, creation, updating, and linking of contacts in sequence, keeping both systems aligned.
Read also
- How to use the Companies module in Papo's CRM
- How to use the Papo API to manage custom contact attributes
Start for free and manage Companies in the CRM via API →
The first Papo user is free forever, no credit card required.