Skip to content

List vendors

Request

Lists vendors from the caller's vendor directory with pagination, scoped server-side to the caller's organization. Page size is capped server-side; results are sorted by sort_field/sort_order when set, or otherwise returned in a best-effort, server-defined order that is not guaranteed stable across requests.

Bodyapplication/jsonrequired

Pagination inputs for listing vendors from the caller's directory. Organization scope is derived from the access token, not from this message.

limitinteger, (int32)

Maximum number of vendors to return per page. Bounded server-side: values above the server maximum of 200 are clamped to 200, and an unset or zero value uses the server default of 50. Must not be negative.

offsetinteger, (int32)

Zero-based offset for page-based pagination; ignored when cursor is provided. Must not be negative.

cursorstring

Opaque pagination cursor, echoed from a prior response's next_cursor. Set to "" or leave unset to request the first page.

filtersArray of objects(PublicVendorFilter)required

Filter expressions applied to narrow the result set: a flat AND-list of rules (each entry must set PublicVendorFilter.rule, not list — see that message). Only the fields and operators in PublicVendorsFilterableField are accepted. Bounded server-side at 20 rules total, each rule's list value (any-of match) at 50 entries; anything else, or a tree that exceeds those limits, is rejected with INVALID_ARGUMENT.

includeFilterOptionsboolean

When true, the response includes the available filter option values for the caller's directory in filter_options.

sortFieldstring

Field to sort results by (e.g. "score" to sort by the vendor's top-level security score); server-defined default order applies when unset.

sortOrderstring(SortOrder)

Sort direction for list and search APIs: ascending, descending, or unspecified.

Default:"SORT_ORDER_UNSPECIFIED"
Enum:"SORT_ORDER_UNSPECIFIED""SORT_ORDER_ASC""SORT_ORDER_DESC"
curl -i -X POST \
  https://docs.titanapi.securityscorecard.io/_mock/openapi.public/public/v1/vendors \
  -H 'Content-Type: application/json' \
  -d '{
    "limit": 0,
    "offset": 0,
    "cursor": "string",
    "filters": [
      {
        "list": {
          "operator": "OPERATOR_UNSPECIFIED",
          "isNegated": true,
          "filters": [
            {}
          ]
        },
        "rule": {
          "field": {
            "vendorsField": "VENDORS_FIELD_UNSPECIFIED"
          },
          "comparison": "COMPARISON_UNSPECIFIED",
          "value": {
            "stringValue": "string",
            "numberValue": 0.1,
            "boolValue": true,
            "stringListValue": {
              "values": [
                "string"
              ]
            },
            "numberRangeValue": {
              "min": 0.1,
              "max": 0.1
            },
            "dateRangeValue": {
              "startTime": "2019-08-24T14:15:22Z",
              "endTime": "2019-08-24T14:15:22Z",
              "live": true
            },
            "dateValue": "2019-08-24T14:15:22Z"
          }
        }
      }
    ],
    "includeFilterOptions": true,
    "sortField": "string",
    "sortOrder": "SORT_ORDER_UNSPECIFIED"
  }'

Responses

A successful response.

Bodyapplication/json
vendorsArray of objects(vendor.v1.Vendor)required

The vendors on this page, curated for public consumption.

totalCountinteger, (int32)required

Total number of vendors in the caller's directory (before pagination).

nextCursorstring

Opaque cursor to pass as cursor in the next request. Absent when no further pages exist.

filterOptionsArray of objects(PublicVendorFilterOption)required

Filter option values available for the caller's directory; populated when include_filter_options is true.

Response
{ "vendors": [ { … } ], "totalCount": 0, "nextCursor": "string", "filterOptions": [ { … } ] }