List all Items for a Webset

Returns a list of Webset Items.

You can paginate through the Items using the cursor parameter.

GET /v0/websets/{webset}/items

List all Items for a Webset

cURL

curl --request GET \
  --url https://api.exa.ai/websets/v0/websets/{webset}/items \
  --header 'x-api-key: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "object": "webset_item",
      "source": "search",
      "sourceId": "<string>",
      "websetId": "<string>",
      "properties": {
        "type": "person",
        "url": "<string>",
        "description": "<string>",
        "person": {
          "name": "<string>",
          "location": "<string>",
          "position": "<string>",
          "company": {
            "name": "<string>",
            "location": "<string>"
          },
          "pictureUrl": "<string>",
          "workHistory": [
            {
              "title": "<string>",
              "location": "<string>",
              "dates": {
                "from": "<string>",
                "to": "<string>"
              },
              "company": {
                "id": "<string>",
                "name": "<string>",
                "linkedinUrl": "<string>"
              }
            }
          ],
          "educationHistory": [
            {
              "degree": "<string>",
              "dates": {
                "from": "<string>",
                "to": "<string>"
              },
              "institution": {
                "id": "<string>",
                "name": "<string>",
                "linkedinUrl": "<string>"
              }
            }
          ]
        }
      },
      "evaluations": [
        {
          "criterion": "<string>",
          "reasoning": "<string>",
          "satisfied": "yes",
          "references": []
        }
      ],
      "enrichments": [
        {
          "object": "enrichment_result",
          "status": "pending",
          "format": "text",
          "result": [
            "<string>"
          ],
          "reasoning": "<string>",
          "references": [
            {
              "title": "<string>",
              "snippet": "<string>",
              "url": "<string>"
            }
          ],
          "enrichmentId": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "sourceEntityId": "<string>",
      "scopeId": "<string>"
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

apiKeybearer

x-api-key · string · header · required

Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer .

Path Parameters

webset · string · required

The id or externalId of the Webset

Query Parameters

cursor · string

The cursor to paginate through the results

Minimum string length: 1

limit · integer · default: 20

The number of results to return

Required range: 1 <= x <= 100

sourceId · string

The id of the source

Response

200 - application/json

Webset Items

data · object[] · required

The list of webset items

Show child attributes

hasMore · boolean · required

Whether there are more Items to paginate through

nextCursor · string | null · required

The cursor to paginate through the next set of Items