# ai_index_orgs_users_documents_pathways_list

Description:
Retrieves a list of document embeddings for a specific pathway with optional search and pagination.

Methods:
- GET: Retrieves document embeddings that match the specified search criteria and are paginated according to offset and limit.

Parameters:
- search (str): Search query to filter document names or URLs.
- offset (int): Offset number for pagination.
- limit (int): Limit number for pagination.

Returns:
- GET: A paginated list of document embeddings with their details.
{
    "count": 10,
    "next": "http://api.example.com/retriever_documents/?offset=10&limit=2",
    "previous": "http://api.example.com/retriever_documents/?offset=0&limit=2",
    "results": [
    {
        "document_name": "Document2",
        "platform_key": "example_platform",
        "pathway": "example_pathway"
    }
    ]
}

Error Responses:
- 400 Bad Request: Invalid query parameters.
- 404 Not Found: No document embeddings found for the specified criteria.

Endpoint: GET /api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/
Version: 3.59.0-ai-plus
Security: PlatformApiKeyAuthentication

## Query parameters:

  - `limit` (integer)
    limit number

  - `offset` (integer)
    Offset number

  - `search` (string)
    Search query

## Path parameters:

  - `org` (string, required)

  - `pathway` (string, required)

  - `user_id` (string, required)

## Response 200 fields (application/json):

  - `count` (integer, required)
    Example: 123

  - `next` (string,null)
    Example: "http://api.example.org/accounts/?offset=400&limit=100"

  - `previous` (string,null)
    Example: "http://api.example.org/accounts/?offset=200&limit=100"

  - `results` (array, required)

  - `results.id` (integer, required)

  - `results.metadata` (any,null)

  - `results.document_name` (string,null)

  - `results.document_type` (string,null)

  - `results.training_status` (any,null)

  - `results.pathway` (string, required)

  - `results.url` (string,null)

  - `results.tokens` (integer,null)

  - `results.platform_key` (string, required)

  - `results.is_trained` (boolean)

  - `results.access` (any,null)

  - `results.crawler_max_depth` (integer,null)

  - `results.crawler_max_pages_limit` (integer,null)

  - `results.crawler_max_concurrency` (integer,null)

  - `results.crawler_match_patterns` (any)
    List of patterns that the crawler should use to match urls. 
        Patterns may be a glob pattern or a full regex pattern. 
        Indicate the specified type in .

  - `results.crawler_use_glob_matching` (boolean)