Skip to content

The people and companies you pay.

One endpoint, with the fields it takes and the fields it gives back.

GET/vendors

Lists the vendors in your account, who expenses are paid to.

  • A key limited to certain businesses still sees every vendor: vendors belong to your account, not to one business.
  • search matches the canonical name, the one this list returns as name, and nothing else. A name as it was written on a receipt does not match unless it is the canonical one.
  • In search, % and _ are wildcards, because the match runs as a SQL ilike.
  • To read the next page, pass the previous response's nextCursor. A null there means you already have everything.

Needs the vendors:read permission. A Read only key has it.

Query parameters

search
Typestring
RequiredOptional
Details
  • up to 200 characters
includeArchived
Typestring
RequiredOptional
Details
  • one of: true, false
cursor
Typestring
RequiredOptional
Details
  • an opaque value from a previous response
limit
Typeinteger
RequiredOptional
Details
  • 1 to 100, default 50
Request
curl "https://www.numm.io/api/v1/vendors" \
  -H "Authorization: Bearer nmo_live_REPLACE_WITH_YOUR_KEY"
Response 200
{
  "vendors": [
    {
      "id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f1004",
      "name": "Office Depot",
      "is1099Eligible": false
    }
  ],
  "nextCursor": null
}

Response fields

vendors
Typearray of object
PresentAlways
vendors[].id
Typestring
PresentAlways
Details
  • a uuid
vendors[].name
Typestring
PresentAlways
vendors[].is1099Eligible
Typeboolean
PresentAlways
nextCursor
Typestring or null
PresentAlways
Details
  • an opaque value from a previous response

Errors

This call can return:

invalid_key
Status401
MeaningYour key is missing, malformed, revoked, or expired.
insufficient_scope
Status403
MeaningYour key does not carry the scope this endpoint needs.
rate_limited
Status429
MeaningYou've made too many requests for this key. The retry-after header says how long to wait.
validation_failed
Status422
MeaningSomething in the path, the query, or the body did not pass validation.
internal_error
Status500
MeaningSomething went wrong on our side. Try again.
Vendors — Nummio API