---
updatedAt: 2026-09-28T14:14:31.000Z
agentTools:
  projectIndex: https://developer.searchblox.com/llms.txt
---

# Listing the Collections - /rest/collection/list

JSON Payload

[block:parameters]
{
  "data": {
    "h-0": "JSON Fields",
    "h-1": "Value",
    "h-2": "Value",
    "0-0": "apikey",
    "0-1": "API key accessible in the Dasboard > Collections > License. It is also present in the config.xml file.",
    "0-2": "License value from license.xml file",
    "1-0": "name",
    "1-1": "Name is the Name of the collection which is optional JSON property."
  },
  "cols": 2,
  "rows": 2
}
[/block]

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "api-settings",
    "version": "12.2"
  },
  "servers": [
    {
      "url": "https://127.0.0.1:8443/"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/rest/collection/list": {
      "post": {
        "summary": "Listing the Collections - /rest/collection/list",
        "description": "JSON Payload",
        "operationId": "listing-the-collections-restcollectionlist",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "description": "application/json",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Accept",
            "in": "header",
            "description": "application/json",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "SB-PKEY",
            "in": "header",
            "description": "Security Key by SBAdmin or Admin",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\"apikey\":\"C6D418861BAD66A46A7CC96B70CEADF9\"\n\"name\":\"site\"\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```