v1

latestOpenAPI 3.1.02026-07-2481742657.4 KB
Tags and Comments

List comments

Retrieve a paginated list of comments in your organization. Use query parameters to filter by asset, creator, or creation time.<br><br>This endpoint does not cost any credits to execute.

get/v3/comments

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

Number of comments to return per page.

Number of comments 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'create_time_asc' | 'create_time_desc'

Sort order. Supported values: create_time_asc, create_time_desc.

Sort order. Supported values: create_time_asc, create_time_desc.

asset_idstring

Filter comments by asset identifier (host IP, certificate fingerprint, or web property hostname:port).

Filter comments by asset identifier (host IP, certificate fingerprint, or web property hostname:port).

created_bystring uuid

Filter comments by the user ID of the user who created the comment.

Filter comments by the user ID of the user who created the comment.

created_beforestring date-time

Filter comments created before this RFC3339 timestamp.

Filter comments created before this RFC3339 timestamp.

created_afterstring date-time

Filter comments created after this RFC3339 timestamp.

Filter comments created after this RFC3339 timestamp.

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

Comments retrieved successfully