# Get a code pool

> Source: /api-reference/partner/explorer/code-pools/get-pool
> Pool detail plus a page of its codes. Filter by `status` and cap the page with `limit`.
> Full spec: https://docs.journey.com/openapi/partner.v1.json

## `GET /v1/partner/code-pools/{poolRef}`

```json
{
  "description": "Pool detail plus a page of its codes. Filter by `status` and cap the page with `limit`.",
  "operationId": "codePoolsPartner_getPool",
  "parameters": [
    {
      "description": "Pool reference — the offer id backing the pool. Must match `^[A-Za-z0-9_-]{1,100}$`.",
      "in": "path",
      "name": "poolRef",
      "required": true,
      "schema": {
        "pattern": "^[A-Za-z0-9_-]{1,100}$",
        "type": "string"
      }
    },
    {
      "description": "Maximum number of codes to return. Must be a positive integer.",
      "in": "query",
      "name": "limit",
      "required": false,
      "schema": {
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "description": "Return only codes in this state.",
      "in": "query",
      "name": "status",
      "required": false,
      "schema": {
        "enum": [
          "available",
          "assigned",
          "redeemed",
          "expired"
        ],
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "The pool and a page of its codes."
    },
    "400": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PartnerErrorResponse"
          }
        }
      },
      "description": "Request validation failed. `errors` lists the offending fields."
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PartnerErrorResponse"
          }
        }
      },
      "description": "No usable credential. Send `Authorization: Bearer <jwt>` or `X-API-Key: jny_...`."
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PartnerErrorResponse"
          }
        }
      },
      "description": "The credential authenticated but lacks the scopes in `x-required-scopes`, or the resource belongs to another organization."
    },
    "404": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PartnerErrorResponse"
          }
        }
      },
      "description": "No such resource, or it is outside the organization the credential resolves to."
    }
  },
  "security": [
    {
      "partnerBearer": []
    },
    {
      "partnerApiKey": []
    }
  ],
  "summary": "Get a code pool",
  "tags": [
    "partner/code-pools"
  ],
  "x-required-scopes": [
    [
      "offers:codes:read"
    ]
  ]
}
```