Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Vendors

List vendors

Endpoint used to list vendor resources

get/vendors

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Vendors returned

customFieldNamestring[]

Filter vendors by custom field value. Your query parameter should be your custom field name. (ie: To filter by a custom field named "Industry" with the value "Construction", you would do this "/vendors?Industry=Construction"). <br><br>Adding multiple instance of the same custom field act as an <code>OR</code> and adding a different custom field act as an <code>AND</code>. (ie: To filter by a custom field named <code>Industry</code> with the value <code>Construction</code> OR <code>Transportation</code> AND the custom field <code>Manufacturer</code> with the value <code>ACME</code>, you would do this <code>/vendors?Industry=Construction&Industry=Transportation&Manufacturer=ACME</code>). <br><br>If your custom field label is the same as a reserved query parameter such as <code>limit</code>, <code>sort</code>, <code>expand</code>, etc, you can add <code>__c</code> to your custom field filtering (ie: To filter by a custom field named <code>limit</code> with the value <code>ten</code>, you would do this <code>/vendors?limit__c=ten</code>). <br><br>Note that your custom field needs to be created beforehand. Only number and single line text custom field types are supported.

expandstring[]

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Vendors list

nextCursorstring nullable required

The cursor to retrieve the next page of Vendors.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Vendors.

Example response

{
  "vendors": [
    {
      "id": 963,
      "name": "Acme Corp",
      "extraFields": {
        "Qualifications": "ISO 000"
      }
    }
  ]
}