CEcensys
Collections

List collections

List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.

get/v3/collections

Request

  • Base URL
    https://api.platform.censys.io
  • URL
    https://api.platform.censys.io/v3/collections
  • Auth
    HTTP bearer

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_tokenstring

page token for the requested page of collection results

page_sizeinteger

amount of results to return per page

Example:1
collection_statusesstring[] nullable

statuses of collection for results to be filtered on.

[
  "populating",
  "active"
]

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

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.