Retrieve a paginated list of accounting vendors | Ottimate Developer Documentation

curl -G https://api.ottimate.com/v1/vendors \
     -H "X-Api-Key: your-api-key-here" \
     -H "X-API-Version: 1.0.0" \
     -H "Authorization: Bearer <token>" \
     -d ottimate_company_id=15196 \
     -d last_modified_date_from=2024-01-01 \
     -d last_modified_date_from_utc=2024-01-01 \
     --data-urlencode "last_modified_date_to=2024-12-31 23:59:59" \
     --data-urlencode "last_modified_date_to_utc=2024-12-31 23:59:59" \
     -d page=1 \
     -d limit=20

{
  "version": "1.0.0",
  "count": 100,
  "page": 1,
  "limit": 20,
  "vendors": [
    {
      "id": 169860239,
      "erp_vendor_name": "Sysco Foods Corp",
      "ottimate_company_id": 15196,
      "company_name": "Sysco Foods Corp",
      "erp_vendor_id": "SYS-001",
      "email": "orders@sysco.com",
      "phone": "+1-555-123-4567",
      "net_terms": "Net 30",
      "payment_method": "wire_transfer",
      "address_line_1": "1 Sysco Way",
      "address_line_2": null,
      "city": "Houston",
      "state": "TX",
      "zipcode": "77077"
    },
    {
      "id": 169860240,
      "erp_vendor_name": "US Foods Inc",
      "ottimate_company_id": 15196,
      "company_name": "Sysco Foods Corp",
      "erp_vendor_id": "USF-002",
      "email": "contact@usfoods.com",
      "phone": "+1-555-987-6543",
      "net_terms": "Net 45",
      "payment_method": "ach",
      "address_line_1": "9399 W Higgins Rd",
      "address_line_2": "Suite 500",
      "city": "Rosemont",
      "state": "IL",
      "zipcode": "60018"
    },
    {
      "id": 169860241,
      "erp_vendor_name": "Performance Food Group",
      "ottimate_company_id": 15197,
      "company_name": "Performance Food Group",
      "erp_vendor_id": "PFG-003",
      "email": null,
      "phone": null,
      "net_terms": null,
      "payment_method": "unknown",
      "address_line_1": null,
      "address_line_2": null,
      "city": null,
      "state": null,
      "zipcode": null
    }
  ]
}

Returns a paginated list of accounting vendors, filterable by company. The detail=basic query parameter returns a simplified response.

Authentication

AuthorizationBearer

OAuth2 authentication flows. Auth server URLs will vary by environment

Query parameters

ottimate_company_idintegerOptional

Filter vendors by company ID

detailenumOptional

Specify the level of detail in the response

Allowed values:

last_modified_date_fromstringOptional

Filter vendors last modified on or after this date. Requires ottimate_company_id. Accepted formats: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. All times are interpreted as UTC. A date-only value is treated as 00:00:00 UTC.

last_modified_date_from_utcstringOptional

UTC filter. Accepts ISO 8601 with optional Z/offset, or YYYY-MM-DD[ HH:MM:SS] (assumed UTC). Takes precedence over the non-_utc variant.

last_modified_date_tostringOptional

Filter vendors last modified on or before this date. Requires ottimate_company_id. Accepted formats: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. All times are interpreted as UTC. A date-only value is treated as 00:00:00 UTC — to include the full day pass an explicit time (e.g. 2024-12-31 23:59:59).

last_modified_date_to_utcstringOptional

UTC filter. Accepts ISO 8601 with optional Z/offset, or YYYY-MM-DD[ HH:MM:SS] (assumed UTC). Takes precedence over the non-_utc variant.

pageintegerOptional

Page number (default 1)

limitintegerOptional

Number of results per page (default 20)

Response

Successful response with paginated vendor list

versionstring

countinteger

pageinteger

limitinteger

vendorslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

Authentication

Headers

Query parameters

Response

Errors