List Contacts | PLEX-DEMO

{
  "data": [
    {
      "id": "contact-123e4567-e89b-12d3-a456-426614174000",
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "lastName": "Smith",
      "email": "john.smith@example.com",
      "phone": "+1-555-0123",
      "title": "Purchasing Manager",
      "companyName": "ACME Corporation",
      "type": "Business",
      "createdDate": "2026-01-15T14:30:00.00Z"
    },
    {
      "id": "contact-223e4567-e89b-12d3-a456-426614174001",
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "Sarah",
      "lastName": "Johnson",
      "email": "sarah.johnson@example.com",
      "phone": "+1-555-0456",
      "title": "Finance Director",
      "companyName": "ACME Corporation",
      "type": "Business",
      "createdDate": "2026-01-20T09:15:00.00Z"
    },
    {
      "id": "contact-323e4567-e89b-12d3-a456-426614174002",
      "firstName": "Michael",
      "lastName": "Chen",
      "email": "m.chen@supplier.com",
      "phone": "+1-555-0789",
      "title": "Sales Representative",
      "companyName": "Supply Company LLC",
      "type": "Business",
      "createdDate": "2026-02-01T11:45:00.00Z",
      "supplierId": "456e4567-e89b-12d3-a456-426614174003"
    }
  ],
  "pagination": {
    "total": 3,
    "limit": 100,
    "offset": 0,
    "hasMore": false
  }
}

Retrieve a paginated list of contacts with optional filtering.

Query parameters

limitintegerOptional

Maximum number of records to return (default: 100, max: 1000)

offsetintegerOptional

Number of records to skip for pagination (default: 0)

customerIdstringOptional

Filter by customer ID

supplierIdstringOptional

Filter by supplier ID

typestringOptional

Filter by contact type (Business, Personal, etc.)

Response

Success Response

datalist of objectsOptional

paginationobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error