COcontentsnare
Requests

Find request by ID

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>

get/partner_api/v1/requests/{id}

Request

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

Path parameters

idstring required

Response

successful

approved_fields_countinteger
author_namestring
board_column_idstring
board_column_sorting_positionunknown
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.

comments_enabledboolean
communications_template_namestring
completion_percentageinteger
country_codestring
done_fields_countinteger
duestring
expires_after_dueboolean
fields_countinteger
folder_namestring
has_commentsboolean
idstring
instruction_textstring
language_codestring
namestring
owner_idstring
owner_namestring
passcode_enabledboolean
primary_client_idstring
redo_fields_countinteger
request_template_namestring
share_linkstring
share_via_link_enabledboolean
show_instructionboolean
status'draft' | 'published' | 'completed' | 'archived' | 'scheduled' | 'waiting' | 'expired'

Request status

wildcardsobject

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.

urlstring
updated_atstring

Example response

{
  "approved_fields_count": 3,
  "author_name": "Laurence Bosco",
  "board_column_id": "bcl_b12Jl28mTJOea5",
  "board_column_sorting_position": 7,
  "build_status": "ready",
  "clients": [
    {
      "avatar": "https://example.com/user_avatar.jpeg",
      "company_name": "Stark Enterprises",
      "email": "keva.ryan@stark.ca",
      "first_name": "Keva",
      "full_name": "Keva Ryan",
      "id": "acc_MORVw9Cyq97AyN",
      "last_name": "Ryan",
      "phone": "+1 (415) 555-1212",
      "salutation": "Dr",
      "url": "https://webcorp.contentsnare.com/shared/b5cd2ffc-b290-40ff-bea9-adea3dc1994b"
    }
  ],
  "comments_enabled": true,
  "communications_template_name": "Default",
  "completion_percentage": 65,
  "country_code": "us",
  "done_fields_count": 1,
  "due": "2024-08-15",
  "fields_count": 4,
  "folder_name": "Folder 1",
  "has_comments": true,
  "id": "req_y8k0w9ASlnD4YX",
  "instruction_text": "<h5>Hi!</h5><div>We’re happy to have you on board! We need some information from you. ...</div>",
  "language_code": "en",
  "name": "Request 1",
  "owner_id": "acc_e7EVAXvJfxZ9zb",
  "owner_name": "Julian Skiles",
  "pages": [
    {
      "approved_fields_count": 1,
      "done_fields_count": 1,
      "fields_count": 2,
      "id": "pag_jAxqEgBi4prM6g",
      "instruction_text": "<h5>Page instruction</h5>",
      "is_approved": true,
      "name": "Page 1",
      "reference_id": "rpag_jAxqEgBi4prM6g"
    }
  ],
  "primary_client_id": "acc_MORVw9Cyq97AyN",
  "request_template_name": "Request Template 1",
  "share_link": "https://webcorp.contentsnare.com/shared/6981788b-ce73-4bd6-985d-4eceec055ef9",
  "share_via_link_enabled": true,
  "show_instruction": true,
  "status": "published",
  "wildcards": {
    "client.contact_first_name": "Fred",
    "client.company_name": "Smith & Sons",
    "clients.contact_first_name": [
      "Fred",
      "Sam"
    ],
    "request.name": "Request 1"
  },
  "url": "https://webcorp.contentsnare.com/requests/143",
  "updated_at": "2025-01-15T12:00:00Z"
}

Changes

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