Sign in

v1

latestOpenAPI 3.1.02026-07-2481742657.4 KB
Supply Chain Intelligence

List suppliers

Returns a paginated list of all suppliers in the given supply chain.<br><br>This endpoint does not cost credits to execute.

get/v1/supplychains/{supply_chain_id}/suppliers

Path parameters

supply_chain_idstring uuid required

The ID of a Censys supply chain. Obtain the supply chain ID using the list supply chains endpoint to find the IDs of your organization's supply chains.

Example:11111111-2222-3333-4444-555555555555

The ID of a Censys supply chain. Obtain the supply chain ID using the list supply chains endpoint to find the IDs of your organization's supply chains.

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

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

page_sizeinteger

Maximum number of suppliers to return per page.

Maximum number of suppliers to return per page.

page_tokenstring

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

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

order_by'id_asc' | 'id_desc' | 'name_asc' | 'name_desc' | 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc'

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

Returned values ordering. Can sort by id, name, created at time and updated 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

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.

Response

Supplier information returned successfully

Example response

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