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

# List all Items for a Webset

> Returns a list of Webset Items.

You can paginate through the Items using the `cursor` parameter.



## OpenAPI

````yaml get /v0/websets/{webset}/items
openapi: 3.1.0
info:
  title: Websets
  description: ''
  version: '0'
  contact: {}
servers:
  - url: https://api.exa.ai/websets/
    description: Production
security: []
tags: []
paths:
  /v0/websets/{webset}/items:
    get:
      tags:
        - Items
      summary: List all Items for a Webset
      description: |-
        Returns a list of Webset Items.

        You can paginate through the Items using the `cursor` parameter.
      operationId: websets-items-list
      parameters:
        - name: webset
          required: true
          in: path
          description: The id or externalId of the Webset
          schema:
            type: string
        - name: cursor
          required: false
          in: query
          description: The cursor to paginate through the results
          schema:
            minLength: 1
            type: string
        - name: limit
          required: false
          in: query
          description: The number of results to return
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: number
        - name: sourceId
          required: false
          in: query
          description: The id of the source
          schema:
            type: string
      responses:
        '200':
          description: Webset Items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebsetItemResponse'
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Unique identifier for the request.
              example: req_N6SsgoiaOQOPqsYKKiw5
              required: true
      security:
        - api_key: []
      x-codeSamples:
        - lang: javascript
          label: JavaScript
          source: |-
            // npm install exa-js
            import Exa from 'exa-js';
            const exa = new Exa('YOUR_EXA_API_KEY');

            const items = await exa.websets.items.list('webset_id', {
              limit: 20
            });

            console.log(`Found ${items.data.length} items`);
            items.data.forEach(item => {
              console.log(`- ${item.id}: ${item.properties.name}`);
            });
        - lang: python
          label: Python
          source: |-
            # pip install exa-py
            from exa_py import Exa
            exa = Exa('YOUR_EXA_API_KEY')

            items = exa.websets.items.list('webset_id', limit=20)

            print(f'Found {len(items.data)} items')
            for item in items.data:
                print(f'- {item.id}: {item.properties.name}')
components:
  schemas:
    ListWebsetItemResponse:
      type:
        - object
      properties:
        data:
          type:
            - array
          items:
            $ref: '#/components/schemas/WebsetItem'
            type:
              - object
          description: The list of webset items
        hasMore:
          type:
            - boolean
          description: Whether there are more Items to paginate through
        nextCursor:
          type:
            - string
            - 'null'
          description: The cursor to paginate through the next set of Items
      required:
        - data
        - hasMore
        - nextCursor
    WebsetItem:
      type:
        - object
      properties:
        id:
          type:
            - string
          description: The unique identifier for the Webset Item
        object:
          type: string
          const: webset_item
          default: webset_item
        source:
          type:
            - string
          enum:
            - search
            - import
          description: The source of the Item
        sourceId:
          type:
            - string
          description: The unique identifier for the source
        websetId:
          type:
            - string
          description: The unique identifier for the Webset this Item belongs to.
        properties:
          oneOf:
            - $ref: '#/components/schemas/WebsetItemPersonProperties'
              type:
                - object
              title: Person
            - $ref: '#/components/schemas/WebsetItemCompanyProperties'
              type:
                - object
              title: Company
            - $ref: '#/components/schemas/WebsetItemArticleProperties'
              type:
                - object
              title: Article
            - $ref: '#/components/schemas/WebsetItemResearchPaperProperties'
              type:
                - object
              title: Research Paper
            - $ref: '#/components/schemas/WebsetItemCustomProperties'
              type:
                - object
              title: Custom
          description: The properties of the Item
        evaluations:
          type:
            - array
          items:
            $ref: '#/components/schemas/WebsetItemEvaluation'
            type:
              - object
          description: The criteria evaluations of the item
        enrichments:
          oneOf:
            - type: array
              items:
                $ref: '#/components/schemas/EnrichmentResult'
            - type: 'null'
          description: The enrichments results of the Webset item
        createdAt:
          type:
            - string
          format: date-time
          description: The date and time the item was created
        updatedAt:
          type:
            - string
          format: date-time
          description: The date and time the item was last updated
      required:
        - id
        - object
        - source
        - sourceId
        - websetId
        - properties
        - evaluations
        - enrichments
        - createdAt
        - updatedAt
    WebsetItemPersonProperties:
      type:
        - object
      properties:
        type:
          type: string
          const: person
          default: person
        url:
          type:
            - string
          format: uri
          description: The URL of the person profile
        description:
          type:
            - string
          description: Short description of the relevance of the person
        person:
          type:
            - object
          properties:
            name:
              type:
                - string
              description: The name of the person
            location:
              type:
                - string
                - 'null'
              description: The location of the person
            position:
              type:
                - string
                - 'null'
              description: The current work position of the person
            company:
              type:
                - object
                - 'null'
              properties:
                name:
                  type:
                    - string
                  description: The name of the company
                location:
                  type:
                    - string
                    - 'null'
                  description: The location the person is working at the company
              required:
                - name
                - location
              title: WebsetItemPersonCompanyPropertiesFields
            pictureUrl:
              type:
                - string
                - 'null'
              format: uri
              description: The image URL of the person
          required:
            - name
            - location
            - position
            - company
            - pictureUrl
          title: WebsetItemPersonPropertiesFields
      required:
        - type
        - url
        - description
        - person
    WebsetItemCompanyProperties:
      type:
        - object
      properties:
        type:
          type: string
          const: company
          default: company
        url:
          type:
            - string
          format: uri
          description: The URL of the company website
        description:
          type:
            - string
          description: Short description of the relevance of the company
        content:
          type:
            - string
            - 'null'
          description: The text content of the company website
        company:
          type:
            - object
          properties:
            name:
              type:
                - string
              description: The name of the company
            location:
              type:
                - string
                - 'null'
              description: The main location of the company
            employees:
              type:
                - integer
                - 'null'
              description: The number of employees of the company
            industry:
              type:
                - string
                - 'null'
              description: The industry of the company
            about:
              type:
                - string
                - 'null'
              description: A short description of the company
            logoUrl:
              type:
                - string
                - 'null'
              format: uri
              description: The logo URL of the company
          required:
            - name
            - location
            - employees
            - industry
            - about
            - logoUrl
          title: WebsetItemCompanyPropertiesFields
      required:
        - type
        - url
        - description
        - content
        - company
    WebsetItemArticleProperties:
      type:
        - object
      properties:
        type:
          type: string
          const: article
          default: article
        url:
          type:
            - string
          format: uri
          description: The URL of the article
        description:
          type:
            - string
          description: Short description of the relevance of the article
        content:
          type:
            - string
            - 'null'
          description: The text content for the article
        article:
          type:
            - object
          properties:
            title:
              type:
                - string
                - 'null'
              description: The title of the article
            author:
              type:
                - string
                - 'null'
              description: The author(s) of the article
            publishedAt:
              type:
                - string
                - 'null'
              description: The date and time the article was published
          required:
            - title
            - author
            - publishedAt
          title: WebsetItemArticlePropertiesFields
      required:
        - type
        - url
        - description
        - content
        - article
    WebsetItemResearchPaperProperties:
      type:
        - object
      properties:
        type:
          type: string
          const: research_paper
          default: research_paper
        url:
          type:
            - string
          format: uri
          description: The URL of the research paper
        description:
          type:
            - string
          description: Short description of the relevance of the research paper
        content:
          type:
            - string
            - 'null'
          description: The text content of the research paper
        researchPaper:
          type:
            - object
          properties:
            title:
              type:
                - string
                - 'null'
              description: The title of the research paper
            author:
              type:
                - string
                - 'null'
              description: The author(s) of the research paper
            publishedAt:
              type:
                - string
                - 'null'
              description: The date and time the research paper was published
          required:
            - title
            - author
            - publishedAt
          title: WebsetItemResearchPaperPropertiesFields
      required:
        - type
        - url
        - description
        - content
        - researchPaper
    WebsetItemCustomProperties:
      type:
        - object
      properties:
        type:
          type: string
          const: custom
          default: custom
        url:
          type:
            - string
          format: uri
          description: The URL of the Item
        description:
          type:
            - string
          description: Short description of the Item
        content:
          type:
            - string
            - 'null'
          description: The text content of the Item
        custom:
          type:
            - object
          properties:
            title:
              type:
                - string
                - 'null'
              description: The title of the website
            author:
              type:
                - string
                - 'null'
              description: The author(s) of the website
            publishedAt:
              type:
                - string
                - 'null'
              description: The date and time the website was published
          required:
            - title
            - author
            - publishedAt
          title: WebsetItemCustomPropertiesFields
      required:
        - type
        - url
        - description
        - content
        - custom
    WebsetItemEvaluation:
      type:
        - object
      properties:
        criterion:
          type:
            - string
          description: The description of the criterion
        reasoning:
          type:
            - string
          description: The reasoning for the result of the evaluation
        satisfied:
          type:
            - string
          enum:
            - 'yes'
            - 'no'
            - unclear
          description: The satisfaction of the criterion
        references:
          default: []
          type:
            - array
          items:
            type:
              - object
            properties:
              title:
                type:
                  - string
                  - 'null'
                description: The title of the reference
              snippet:
                type:
                  - string
                  - 'null'
                description: The relevant snippet of the reference content
              url:
                type:
                  - string
                format: uri
                description: The URL of the reference
            required:
              - title
              - snippet
              - url
          description: The references used to generate the result.
      required:
        - criterion
        - reasoning
        - satisfied
    EnrichmentResult:
      type:
        - object
      properties:
        object:
          type: string
          const: enrichment_result
          default: enrichment_result
        status:
          type:
            - string
          enum:
            - pending
            - completed
            - canceled
          description: The status of the enrichment result.
        format:
          $ref: '#/components/schemas/WebsetEnrichmentFormat'
          type:
            - string
        result:
          type:
            - array
            - 'null'
          items:
            type:
              - string
          description: The result of the enrichment.
        reasoning:
          type:
            - string
            - 'null'
          description: The reasoning for the result when an Agent is used.
        references:
          type:
            - array
          items:
            type:
              - object
            properties:
              title:
                type:
                  - string
                  - 'null'
                description: The title of the reference
              snippet:
                type:
                  - string
                  - 'null'
                description: The relevant snippet of the reference content
              url:
                type:
                  - string
                format: uri
                description: The URL of the reference
            required:
              - title
              - snippet
              - url
          description: The references used to generate the result.
        enrichmentId:
          type:
            - string
          description: The id of the Enrichment that generated the result
      required:
        - object
        - status
        - format
        - result
        - reasoning
        - references
        - enrichmentId
    WebsetEnrichmentFormat:
      type: string
      enum:
        - text
        - date
        - number
        - options
        - email
        - phone
        - url
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: x-api-key
      description: Your Exa API key

````