GET All Suppliers

Retrieves a paginated list of all suppliers. The response includes both supplier data and pagination information.

Parameters:

limit: Number of records per page (1-1000)

page: Page number for pagination

search: Optional search term to filter results (name, email, phone, etc.)

sort: Optional field to sort by (id, name, created, etc.)

direction: Optional sort direction (asc or desc)

Response:

{
  "result": "success",
  "code": 200,
  "data": [
    {
      "Supplier": {
        "id": 1,
        "supplier_number": "SUP001",
        "business_name": "Supply Co",
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "jane.smith@example.com",
        "phone1": "555-9876",
        "address1": "456 Market St",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94103",
        "country_code": "US",
        "created": "2023-01-10 09:15:22",
        "modified": "2023-03-05 14:20:30"
        // Additional supplier fields...
      }
    },
    // Additional suppliers...
  ],
  "pagination": {
    "page": 1,
    "page_count": 2,
    "total_results": 35,
    "prev": null,
    "next": "/api2/suppliers.json?page=2"
  }
}

{ "result": "success", "code": 200, "data": [ { "Supplier": { "id": 1, "supplier_number": "SUP001", "business_name": "Supply Co", "first_name": "Jane", "last_name": "Smith", "email": "jane.smith@example.com", "phone1": "555-9876", "address1": "456 Market St", "city": "San Francisco", "state": "CA", "postal_code": "94103", "country_code": "US", "created": "2023-01-10 09:15:22", "modified": "2023-03-05 14:20:30", "balance": 750.00, "active": 1 } }, { "Supplier": { "id": 2, "supplier_number": "SUP002", "business_name": "Office Depot Inc.", "first_name": "Robert", "last_name": "Johnson", "email": "robert.johnson@officedepot.com", "phone1": "555-3456", "address1": "789 Commerce Way", "city": "Dallas", "state": "TX", "postal_code": "75201", "country_code": "US", "created": "2023-01-15 11:20:15", "modified": "2023-02-28 09:45:20", "balance": 1200.00, "active": 1 } } ], "pagination": { "page": 1, "page_count": 2, "total_results": 35, "prev": null, "next": "/api2/suppliers.json?page=2" } }

Request

Responses