Skip to main content
POST
/
list-contacts
curl -X POST https://api.magpipe.ai/functions/v1/list-contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 20,
    "search": "john",
    "tags": ["customer"]
  }'

{
  "contacts": [
    {
      "id": "c1d2e3f4-5678-9abc-def0-123456789abc",
      "phone_number": "+14155551234",
      "name": "John Smith",
      "email": "john@example.com",
      "company": "Acme Corp",
      "tags": ["customer", "vip"],
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": "d2e3f4a5-6789-bcde-f012-34567890abcd",
      "phone_number": "+14155555678",
      "name": "Johnny Doe",
      "email": "johnny@example.com",
      "company": null,
      "tags": ["customer"],
      "updated_at": "2024-01-14T15:00:00Z"
    }
  ],
  "total": 2,
  "has_more": false
}
Retrieve contacts from your address book with filtering by tags, search, and pagination.

​
Request Body

​
limit
integer
default:50
Maximum contacts to return. Max: 100.
​
offset
integer
default:0
Number of records to skip for pagination.
​
search
string
Search contacts by name, phone number, email, or company.
​
tags
array
Filter by tags (contact must have all specified tags).Example: ["customer"]
​
sort_by
string
default:"updated_at"
Sort field: name, created_at, or updated_at.
​
sort_order
string
default:"desc"
Sort order: asc or desc.

​
Response

​
contacts
array
Array of contact objects.
​
total
integer
Total number of contacts matching filters.
​
has_more
boolean
Whether there are more contacts to paginate.
curl -X POST https://api.magpipe.ai/functions/v1/list-contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 20,
    "search": "john",
    "tags": ["customer"]
  }'

{
  "contacts": [
    {
      "id": "c1d2e3f4-5678-9abc-def0-123456789abc",
      "phone_number": "+14155551234",
      "name": "John Smith",
      "email": "john@example.com",
      "company": "Acme Corp",
      "tags": ["customer", "vip"],
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": "d2e3f4a5-6789-bcde-f012-34567890abcd",
      "phone_number": "+14155555678",
      "name": "Johnny Doe",
      "email": "johnny@example.com",
      "company": null,
      "tags": ["customer"],
      "updated_at": "2024-01-14T15:00:00Z"
    }
  ],
  "total": 2,
  "has_more": false
}