---
title: "List requests"
method: GET
path: "/partner_api/v1/requests"
tags: ["Requests"]
---

# List requests

`GET /partner_api/v1/requests`

## Request

- Base URL: `https://api.contentsnare.com`
- URL: `https://api.contentsnare.com/partner_api/v1/requests`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/oauth/authorization`
    - Token URL: `/oauth/token` scopes: `read_requests`
  - HTTP bearer

Returns list of requests<br>Required scopes: <b>read_requests</b>

## Query parameters

- `limit` integer
- `offset` integer
- `q` string
- `q_by[]` string[]
- `filter_by[statuses][]` string[]
- `sort_by` 'name' | 'due' | 'status' | 'updated_at'
- `sort_direction` 'asc' | 'desc'
- `expand[]` string[]

## Response `200`

successful

- object
  - `pagination` PaginationRequests
    - `limit` integer
    - `offset` integer
    - `q` string
    - `q_by` string[]
    - `sort_by` string
    - `sort_direction` string
    - `total_count` integer
    - `filter_by` object
      - `statuses` string[]
  - `results` union[]
    - union
      - IndexRequest
        - `due` string
        - `expires_after_due` boolean
        - `folder_name` string
        - `id` string
        - `name` string
        - `share_link` string
        - `status` 'draft' | 'published' | 'completed' | 'archived' | 'scheduled' | 'waiting' | 'expired': Request status
        - `updated_at` string
      - IndexRequestWithExpand
        - `due` string
        - `expires_after_due` boolean
        - `folder_name` string
        - `id` string
        - `name` string
        - `share_link` string
        - `status` 'draft' | 'published' | 'completed' | 'archived' | 'scheduled' | 'waiting' | 'expired': Request status
        - `updated_at` string
        - `request_template_name` string
        - `owner_email` string
        - `owner_name` string
        - `published_at` string, date-time
        - `all_fields_completed_at` string, date-time
        - `last_client_field_completed_at` string, date-time
        - `last_team_field_reviewed_at` string, date-time
        - `clients` ClientInRequest[]
          - `avatar` string
          - `company_name` string
          - `email` string
          - `first_name` string
          - `full_name` string
          - `id` string
          - `last_name` string
          - `phone` string
          - `salutation` string
          - `url` string

## Other responses

- `401`: unauthorized
- `403`: forbidden

---

[API](https://skmtc.dev/contentsnare/apis/api-general-info.md) - [All operations](https://skmtc.dev/contentsnare/apis/api-general-info/llms.txt) - [OpenAPI document](https://skmtc.dev/contentsnare/apis/api-general-info/revisions/d3048549a0ba?raw)
