CEcensys
Supplier Risk

List suppliers

Changed on

Retrieve a paginated list of all suppliers in your supply chain. Use default as the supply chain ID to target your organization's primary supply chain.<br><br>This endpoint does not cost credits to execute.

get/v1/supplychains/{supply_chain_id}/suppliers

Request

  • Base URL
    https://api.platform.censys.io
  • URL
    https://api.platform.censys.io/v1/supplychains/{supply_chain_id}/suppliers
  • Auth
    HTTP bearer

Path parameters

supply_chain_idstring required

The ID of a Censys supply chain, or the literal 'default' for your organization's primary supply chain. Obtain the supply chain ID using the list supply chains endpoint or from the Supplier Risk URL in the web console.

Example:11111111-2222-3333-4444-555555555555

Query parameters

organization_idstring uuid required

The ID of a Censys organization to associate the request with. See the Getting Started docs for more information.

Example:11111111-2222-3333-4444-555555555555
page_sizeinteger

Maximum number of suppliers to return per page.

page_tokenstring

Pagination token from a previous response to retrieve the next page of results.

order_by'name_asc' | 'name_desc' | 'created_at_asc' | 'created_at_desc'

Returned values ordering. Can sort by name and created at time and can order by ascending and descending results.

Headers

X-Organization-IDstring uuid

The ID of a Censys organization to associate the request with. See the Getting Started docs for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter.

Example:11111111-2222-3333-4444-555555555555

Response

Supplier information returned successfully

Example response

{
  "result": {
    "suppliers": [
      {
        "id": "11111111-2222-3333-4444-555555555555"
      }
    ]
  }
}

Changes

  • ec1686b0a36aRevision changes
    • breaking

      for the query request parameter order_by, default value was changed from id_asc to name_asc

    • breaking

      removed the enum value id_asc from the query request parameter order_by

    • breaking

      removed the enum value id_desc from the query request parameter order_by

    • breaking

      removed the enum value updated_at_asc from the query request parameter order_by

    • breaking

      removed the enum value updated_at_desc from the query request parameter order_by

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      removed the required property /// from the response with the status

    • info

      api tag Supplier Risk added

    • info

      api tag Supply Chain Intelligence removed

    • info

      for the path request parameter supply_chain_id, the format was generalized from uuid to no format

    • info

      added the non-success response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status