> ## Documentation Index
> Fetch the complete documentation index at: https://docs.postcode.gov.ng/llms.txt
> Use this file to discover all available pages before exploring further.

# List the session user's bookmarked postcodes

> Minimal fields only. A session for an unknown identifier returns an empty list. Served by the platform host, not the gateway.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/widget/bookmarks
openapi: 3.1.0
info:
  title: NIPOST Postcode Gateway — Public API
  version: 0.1.0
  description: >
    Public API for Nigeria's national postcode system. Search and Lookup L1 are
    free; Lookup L2–L4 are commercial (credits); L5 is restricted. Authenticate
    with an API key.
servers:
  - url: https://api.postcode.gov.ng
    description: Production
  - url: http://localhost:8081
    description: Local gateway
security:
  - ApiKeyAuth: []
paths:
  /v1/widget/bookmarks:
    get:
      summary: List the session user's bookmarked postcodes
      description: >-
        Minimal fields only. A session for an unknown identifier returns an
        empty list. Served by the platform host, not the gateway.
      responses:
        '200':
          description: Bookmarks, newest first
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      bookmarks:
                        type: array
                        items:
                          $ref: '#/components/schemas/WidgetBookmark'
        '401':
          description: Missing or invalid widget token
        '429':
          description: Rate limited
      security:
        - WidgetToken: []
      servers:
        - url: https://platform.postcode.gov.ng
          description: Production platform
        - url: http://localhost:8082
          description: Local platform
components:
  schemas:
    WidgetBookmark:
      type: object
      properties:
        postcode:
          type: string
          example: EK-01-A03-FK-01
        label:
          type: string
          example: Home
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    WidgetToken:
      type: http
      scheme: bearer
      description: Short-lived widget session JWT from POST /v1/widget/session

````