---
title: "Find request by ID"
method: GET
path: "/partner_api/v1/requests/{id}"
tags: ["Requests"]
---

# Find request by ID

`GET /partner_api/v1/requests/{id}`

## Request

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

Returns a request with specific ID. For asynchronous request creation, poll about every 10 seconds while `build_status` is `building`; stop on `ready` or `failed`. After a 10-minute client deadline, preserve the request ID and report it as pending rather than failed. Honor `Retry-After` on 429, use exponential backoff capped at 60 seconds on 5xx, and stop on 404.<br>Required scopes: <b>read_requests</b>

## Path parameters

- `id` string, required

## Response `200`

successful

- ShowRequest
  - `approved_fields_count` integer
  - `author_name` string
  - `board_column_id` string
  - `board_column_sorting_position` unknown
  - `build_status` 'building' | 'ready' | 'failed', required: Derived page-build state: failed if any page failed; building if no page failed and any page is not created; ready if all pages are created or none exist. Building is the only non-terminal value.
  - `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
  - `comments_enabled` boolean
  - `communications_template_name` string
  - `completion_percentage` integer
  - `country_code` string
  - `done_fields_count` integer
  - `due` string
  - `expires_after_due` boolean
  - `fields_count` integer
  - `folder_name` string
  - `has_comments` boolean
  - `id` string
  - `instruction_text` string
  - `language_code` string
  - `name` string
  - `owner_id` string
  - `owner_name` string
  - `pages` TabInRequest[]
    - `approved_fields_count` integer
    - `done_fields_count` integer
    - `fields_count` integer
    - `id` string
    - `instruction_text` string
    - `is_approved` boolean
    - `is_done` boolean
    - `name` string
    - `redo_fields_count` integer
    - `reference_id` string: A reference ID is an identifier, unique within a request, that remains consistent across all instances of a page in multiple requests and request templates
    - `show_instruction` boolean
    - `sorting_position` integer
  - `passcode_enabled` boolean
  - `primary_client_id` string
  - `redo_fields_count` integer
  - `request_template_name` string
  - `share_link` string
  - `share_via_link_enabled` boolean
  - `show_instruction` boolean
  - `status` 'draft' | 'published' | 'completed' | 'archived' | 'scheduled' | 'waiting' | 'expired': Request status
  - `wildcards` object: Every supported instruction tag with its value for this request, keyed by the bare tag name. Values are raw text; sanitise them before you place them into HTML. A tag with nothing to resolve from has an empty value. The `clients.*` tags hold a list of strings, one per client, primary first. Join it in the viewer's language. The list is empty when nothing resolves it.
  - `url` string
  - `updated_at` string

## Other responses

- `401`: unauthorized
- `403`: forbidden
- `404`: not found

---

[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)