Skip to content
Full-Fill Docs

Get questionnaire

GET
/api/v2/filler/questionnaires/{id}/
curl --request GET \
  --url https://api.full-fill.ai/api/v2/filler/questionnaires/example/ \
  --header 'X-API-Key: <X-API-Key>'

Get a single questionnaire with full details.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
/^\d+$/

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
id
integer
file
object
id
required
integer
original_filename
required
string
file_format
required
string
status
required
string
created_at
required
string format: date-time
file_name
string
client
string
nullable <= 200 characters
status

Current approval status of the questionnaire

  • ready - Ready
  • draft - Draft
  • in_review - In Review
  • approved - Approved
string
Allowed values: ready draft in_review approved
status_display
string
visibility

Visibility scope: organization-wide or team-based access

  • organization - Organization
  • team - Team
string
Allowed values: organization team
user

Return full name of file owner, falling back to username.

string
answers_count

Return count of questions/answers.

integer
approved_count

Return count of approved answers.

integer
submitted_for_review_at

When questionnaire was submitted for review

string format: date-time
nullable
approved_at

When questionnaire was approved

string format: date-time
nullable
owner
string
reviewers
Array<string>
contributors
Array<string>
my_role

Get user’s highest role for this questionnaire (from assignment or team membership).

string
permissions
object
key
additional properties
stats
object
key
additional properties
teams
Array<object>

Brief team info for questionnaire listing.

object
id
required
integer
name
required
string
my_teams

Get user’s teams that have access to this questionnaire.

object
key
additional properties
relevant_offerings
Array<object>

Brief offering info for file listings

object
id
integer
name
required

Name of the offering

string
<= 200 characters
type
required

Type of offering

  • service - Service
  • product - Product
  • module - Module
string
Allowed values: service product module
scope_includes_company

Return whether questionnaire scope includes company.

boolean
detected_language

ISO 639-1 language code detected from questionnaire content

string
effective_language

Return the effective language (user override or detected).

string
can_access
boolean
can_edit
boolean
can_approve
boolean
can_assign
boolean
Example
{
  "status": "ready",
  "visibility": "organization",
  "relevant_offerings": [
    {
      "type": "service"
    }
  ]
}