Skip to content

BillptGetContacts

Gets contacts/customers from Bill.pt. Supports getting a specific one by ID or listing with pagination and search by name or NIF.

FieldTypeRequiredDescription
credentials_idcredentialsYesBill.pt credential
contact_idtextNoSpecific contact ID (if empty, lists all)
searchtextNoText to filter by name or NIF
per_pagenumberNoResults per page (default: 50)
pagenumberNoPage number (default: 1)

This module requires a billpt type credential with the following fields:

  • API Token: Bill.pt API access token

Individual:

{
"success": true,
"contact": { "id": 123, "name": "...", ... }
}

List:

{
"success": true,
"contacts": [ ... ],
"total": 150,
"page": 1
}
  • GET /contacts/{id} - Individual contact
  • GET /contacts - List contacts
{
"contact_id": "123"
}
{
"search": "Empresa XYZ",
"per_page": 20
}
  • If contact_id is provided, a single contact is returned
  • If contact_id is not provided, all contacts are listed with pagination
  • The search field filters by name and NIF