Skip to main content

​
List Contacts

Retrieve a paginated list of contacts across your organization.
​
page
integer
default:"1"
Page number for pagination.
​
limit
integer
default:"50"
Number of contacts to return per page. Also accepts per_page.
Permission: contacts:read 
curl -X GET "https://api.pipelinegeneration.ai/v1/contacts?page=1&limit=25" \
  -H "x-api-key: your_api_key"

{
  "data": [
    {
      "id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "[email protected]",
      "job_title": "VP of Engineering",
      "company": "Acme Corporation",
      "linkedin_url": "https://linkedin.com/in/janesmith"
    },
    {
      "id": "d2e3f4a5-b6c7-8901-defg-234567890123",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "job_title": "CTO",
      "company": "TechCorp",
      "linkedin_url": "https://linkedin.com/in/johndoe"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 2
  }
}

​
Get Contact

Retrieve detailed information about a specific contact by ID.
​
contact_id
string
required
The unique identifier (UUID) of the contact.
Permission: contacts:read 
curl -X GET "https://api.pipelinegeneration.ai/v1/contacts/{contact_id}" \
  -H "x-api-key: your_api_key"

{
  "id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
  "first_name": "Jane",
  "last_name": "Smith",
  "email": "[email protected]",
  "job_title": "VP of Engineering",
  "company": "Acme Corporation",
  "linkedin_url": "https://linkedin.com/in/janesmith",
  "location": "San Francisco, CA",
  "phone": "+1-555-0100",
  "created_at": "2026-01-15T09:00:00Z",
  "updated_at": "2026-03-10T14:30:00Z"
}

{
  "error": "Contact not found"
}

​
Create Contact

Create a new contact in your PG:AI workspace.
​
first_name
string
required
The contact’s first name.
​
last_name
string
required
The contact’s last name.
​
email
string
required
The contact’s email address.
​
job_title
string
The contact’s job title.
​
company
string
The contact’s company name.
​
linkedin_url
string
The contact’s LinkedIn profile URL.
​
phone
string
The contact’s phone number.
​
location
string
The contact’s location.
Permission: contacts:write 
curl -X POST "https://api.pipelinegeneration.ai/v1/contacts" \
  -H "x-api-key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Sarah",
    "last_name": "Connor",
    "email": "[email protected]",
    "job_title": "Director of Sales",
    "company": "Future Tech Inc",
    "linkedin_url": "https://linkedin.com/in/sarahconnor"
  }'

{
  "id": "f4a5b6c7-d8e9-0123-abcd-456789012345",
  "first_name": "Sarah",
  "last_name": "Connor",
  "email": "[email protected]",
  "job_title": "Director of Sales",
  "company": "Future Tech Inc",
  "linkedin_url": "https://linkedin.com/in/sarahconnor",
  "created_at": "2026-03-12T10:00:00Z"
}

{
  "error": "first_name is required"
}