COcontentsnare
Requests

List requests

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

get/partner_api/v1/requests

Request

  • Base URL
    https://api.contentsnare.com
  • Auth
    • OAuth 2
      Authorization code: /oauth/authorization
      Token URL: /oauth/token scopes: read_requests
    • or HTTP bearer

Query parameters

limitinteger
Example:20

Specifies the maximum number of returned items

offsetinteger

Specifies how many items to skip from the beginning

qstring

String to search in the values specified in the parameter q_by[]

q_by[]string[]

Specifies list of values where string from the parameter q will be searched. If it isn't set then the default list is used.<br><b>Examples:</b> q_by[]=name&q_by[]=clients.full_name&q_by[]=client_companies.name

filter_by[statuses][]string[]

Specifies list of statuses for filtering<br><b>Examples:</b> filter_by[statuses][]=published&filter_by[statuses][]=completed

sort_by'name' | 'due' | 'status' | 'updated_at'

Specifies value for sorting

sort_direction'asc' | 'desc'

Specifies direction for sorting

expand[]string[]

Include additional data in response<br><b>Examples:</b> expand[]=request_template_name&expand[]=owner_email&expand[]=owner_name&expand[]=clients<br>expand[]=published_at&expand[]=all_fields_completed_at&expand[]=last_client_field_completed_at&expand[]=last_team_field_reviewed_at

Response

successful

Example response

{
  "pagination": {
    "limit": 200,
    "q": "str",
    "q_by": [
      "name",
      "clients.full_name",
      "client_companies.name"
    ],
    "sort_by": "name",
    "sort_direction": "asc",
    "total_count": 425,
    "filter_by": {
      "statuses": [
        "published",
        "completed"
      ]
    }
  },
  "results": [
    {
      "due": "2024-08-15",
      "folder_name": "Folder 1",
      "id": "req_1k7zv4aUlpN8PB",
      "name": "Request 1",
      "share_link": "https://webcorp.contentsnare.com/shared/6981788b-ce73-4bd6-985d-4eceec055ef9",
      "status": "published",
      "updated_at": "2025-01-15T12:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.