Operations (sample payloads)
Main operations
Create application
Create an application. Sample Input Sample Output
{
"id": 98765,
"applicant": \{
"id": 12345,
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@example.com"
\},
"average_score": 85.5,
"collaborators": [
\{
"first_name": "Jane",
"last_name": "Smith",
"email": "janesmith@example.com",
"id": 23456
\}
],
"created_at": "2023-05-15T10:30:00Z",
"current_stage": \{
"id": 1,
"title": "Initial Review"
\},
"custom_fields": [
\{
"id": 1001,
"name": "Education Level",
"value": "PhD"
\},
\{
"id": 1002,
"name": "Field of Study",
"value": "Molecular Biology"
\}
],
"decision": \{
"id": 1,
"decision": 0,
"awarded": null
\},
"labels": [
\{
"id": 101,
"name": "High Priority"
\}
],
"notes": [
{
"id": 5001,
"author": \{
"id": 34567,
"first_name": "Alice",
"last_name": "Johnson",
"email": "alicejohnson@example.com"
\},
"author_role": 2,
"content": "Promising application, needs further review.",
"edited": false,
"created_at": "2023-05-15T11:00:00Z",
"is_private": true,
"updated_at": "2023-05-15T11:00:00Z"
}
],
"organization": \{
"id": 54321,
"name": "University of Science"
\},
"overall_score": 87.2,
"program": \{
"id": 67890,
"name": "Research Grant Program 2023"
\},
"reference_id": "RGP2023-98765",
"state": 0,
"status": 1,
"title": "Research Grant Application 2023",
"updated_at": "2023-05-15T11:30:00Z",
"weighted_score": 88.5,
"last_submitted_at": "2023-05-15T10:45:00Z"
}
Create user
Create a user. Sample Input
{
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"roles": [
"applicant",
"reviewer"
],
"status": true,
"timezone": "America/New_York",
"custom_fields": {
"applicant": [
\{
"id": 1,
"name": "Department",
"value": "Engineering"
\},
\{
"id": 2,
"name": "Years of Experience",
"value": "5"
\}
],
"reviewer": [
\{
"id": 3,
"name": "Expertise",
"value": "Software Development"
\}
]
}
}
Sample Output
{
"id": 12345,
"status": 1,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"direct_messages": true,
"email_subscribed": true,
"email_verified": false,
"language_preference": "en",
"last_active": "2023-05-15T10:30:00Z",
"signed_up": "2023-05-15T10:00:00Z",
"timezone": "America/New_York",
"roles": [
"applicant",
"reviewer"
],
"custom_fields": {
"applicant": [
\{
"id": 1,
"name": "Department",
"value": "Engineering"
\},
\{
"id": 2,
"name": "Years of Experience",
"value": "5"
\}
]
}
}
Get application task
Retrieve a task from an application by ID. Sample Input
\{
"application_id": 123456,
"application_task_id": 789012
\}
Sample Output
{
"id": 789012,
"name": "Personal Information",
"type": 1,
"status": 2,
"completed_at": "2023-05-15T14:30:00Z",
"created_at": "2023-05-10T09:00:00Z",
"updated_at": "2023-05-15T14:30:00Z",
"data": {
"eVFPEUE5cG": \{
"label": "Full Name",
"response": "John Doe"
\},
"LHdhoAOUzM": \{
"label": "Email Address",
"response": "johndoe@example.com"
\},
"OwJk9ropKN_0": \{
"label": "Phone Number",
"response": "+1 (555) 123-4567"
\},
"Rd6veHoXkI": \{
"label": "Date of Birth",
"response": "1990-05-20"
\},
"TqpS6recHe": \{
"label": "Current Occupation",
"response": "Software Engineer"
\},
"yJxaxPv29k": \{
"label": "Years of Experience",
"response": [
5
]
\}
},
"stage": \{
"id": 1001,
"title": "Application Review"
\}
}
Get task file
Download a file by ID from a task. Sample Input
\{
"application_id": 12345,
"application_task_id": 67890,
"file_id": "abcdef123456"
\}
Sample Output
{
"file": \{
"name": [
"resume.pdf"
],
"url": "https://api.surveymonkey.com/v3/apply/applications/12345/tasks/67890/files/abcdef123456/download",
"mime_type": "application/pdf",
"expires": 1623456789
\}
}
List application tasks
Retrieve a list of all tasks from an application. Sample Input
\{
"application_id": 123456,
"page": 1,
"per_page": 250
\}
Sample Output
{
"results": [
{
"id": 987654,
"name": "Personal Information",
"type": 1,
"status": 2,
"completed_at": "2023-05-15T14:30:00Z",
"created_at": "2023-05-10T09:00:00Z",
"updated_at": "2023-05-15T14:30:00Z",
"data": {
"12bvNyRFIT_0": \{
"label": "Full Name",
"response": "John Doe"
\},
"02r56zwbPk": [
\{
"id": 123,
"filename": "resume.pdf",
"uploaded_at": "2023-05-12T10:15:00Z",
"size": 1024000,
"url": "https://example.com/files/resume.pdf"
\}
]
},
"stage": \{
"id": 1,
"title": "Application Review"
\}
}
],
"next": "https://api.surveymonkey.com/v3/applications/123456/tasks?page=2",
"previous": null,
"num_pages": 3,
"page": 1,
"per_page": 250,
"count": 750,
"filters_applied": {
"A": "123456"
}
}
List applications
Retrieve a list of applications visible to the user. Sample Input
\{
"page": 1,
"per_page": 10,
"program_id": 12345,
"state": "0",
"created_at": "2023-05-01T00:00:00"
\}
Sample Output
{
"results": [
{
"id": 98765,
"applicant": \{
"id": 54321,
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@example.com"
\},
"average_score": 85.5,
"collaborators": [
\{
"first_name": "Jane",
"last_name": "Smith",
"email": "janesmith@example.com",
"id": 67890
\}
],
"created_at": "2023-05-01T10:30:00",
"current_stage": \{
"id": 2,
"title": "Interview"
\},
"custom_fields": [
\{
"id": 1,
"name": "Years of Experience",
"value": "5"
\}
],
"decision": \{
"id": 3,
"decision": 1,
"awarded": "Yes"
\},
"labels": [
\{
"id": 4,
"name": "High Priority"
\}
],
"notes": [
{
"id": 123,
"author": \{
"id": 456,
"first_name": "Alice",
"last_name": "Johnson",
"email": "alicejohnson@example.com"
\},
"author_role": 2,
"content": "Excellent candidate, proceed to next round.",
"edited": false,
"created_at": "2023-05-02T14:15:00",
"is_private": true,
"updated_at": "2023-05-02T14:15:00"
}
],
"organization": "ABC Corp",
"overall_score": 88,
"program": \{
"id": 12345,
"name": "Summer Internship 2023"
\},
"reference_id": "REF-2023-001",
"state": 0,
"status": 1,
"title": "Software Engineering Intern Application",
"updated_at": "2023-05-03T09:45:00",
"weighted_score": 87.2,
"last_submitted_at": "2023-05-01T11:00:00"
}
],
"next": "https://api.surveymonkey.com/v3/apply/applications?page=2&per_page=10",
"previous": null,
"num_pages": 5,
"page": 1,
"per_page": 10,
"count": 47,
"filters_applied": \{
"program_id": "12345",
"state": "0",
"created_at": "2023-05-01T00:00:00"
\}
}
List organizations
Retrieve a list of organizations visible to the user. Sample Input
\{
"page": 1,
"per_page": 10
\}
Sample Output
{
"results": [
{
"id": 12345,
"name": "Acme Corporation",
"address": "123 Main St",
"city": "New York",
"custom_fields": [
\{
"id": 1,
"name": "Industry",
"value": "Technology"
\},
\{
"id": 2,
"name": "Employee Count",
"value": "500-1000"
\}
],
"country": "United States",
"phone": "+1 (555) 123-4567",
"tax_country": 840,
"tax_number": "12-3456789",
"logo_url": "https://example.com/acme_logo.png",
"status": 1,
"created_at": "2023-01-15T10:30:00Z",
"updated_at": "2023-05-20T14:45:00Z",
"website": "https://www.acmecorp.com",
"email": "info@acmecorp.com",
"primary_admin": \{
"id": 9876,
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@acmecorp.com"
\}
}
],
"next": "https://api.surveymonkey.com/v3/organizations?page=2&per_page=10",
"previous": null,
"num_pages": 5,
"page": 1,
"per_page": 10,
"count": 47,
"filters_applied": {
"A": "active"
}
}
List programs
Retrieve a list of programs visible to the user. Sample Input
\{
"page": 1,
"per_page": 10
\}
Sample Output
{
"results": [
{
"id": 12345,
"allow_collaborators": true,
"close_datetime": "2023-12-31T23:59:59Z",
"open_datetime": "2023-01-01T00:00:00Z",
"categories": [
"Education",
"Technology"
],
"custom_fields": [
\{
"id": 1,
"name": "Project Duration",
"value": "6 months"
\}
],
"access": 2,
"active": true,
"applicant_type": 1,
"application_prefix": "TECH2023",
"application_title_help": "Enter a brief title for your project",
"collaborator_domains": [
"example.com",
"university.edu"
],
"collaborator_invite_instructions": "Invite team members using their email addresses",
"custom_value": "High Priority",
"description": "Technology Innovation Grant Program for 2023",
"enable_application_limit": true,
"grace_period": 7,
"hide_value_from_applicants": false,
"identifier": "TIG2023",
"include_deadline_in_reminders": true,
"limit_collaborator_domains": true,
"listing_url": "https://apply.surveymonkey.com/programs/tech-innovation-2023",
"max_applications": 500,
"max_value": "100000",
"name": "Technology Innovation Grant 2023",
"no_application_dates": false,
"no_close_date": false,
"number_of_awards": 10,
"publicity": 1,
"randomize_application_id": false,
"require_application_title": true,
"score_format": 2,
"launched": true,
"summary": "Funding for innovative technology projects",
"value": "1000000",
"value_type": 1,
"awards_made": 0,
"created_at": "2022-12-15T10:30:00Z",
"updated_at": "2023-01-05T14:45:00Z"
}
],
"next": "https://api.surveymonkey.com/v3/apply/programs?page=2&per_page=10",
"previous": null,
"num_pages": 5,
"page": 1,
"per_page": 10,
"count": 47,
"filters_applied": {
"A": "active"
}
}
List stages
Retrieve a list of stages visible to the user. Sample Input Sample Output
{
"results": [
{
"title": "Application Review",
"applicant_customfields_visible_to_recommenders": [
"field1",
"field2"
],
"grace_period": 48,
"recommenders_can_see_other_organization_applications": false,
"recommenders_can_see_applicant_customfields": true,
"recommenders_can_see_organization_decision_history": false,
"index": 1,
"instructions": "Please complete all required fields.",
"type": 1,
"all_tasks_visible_to_applicant": true,
"custom_statuses": [
"In Progress",
"Under Review",
"Approved",
"Rejected"
],
"close_timestamp": "2023-12-31T23:59:59Z",
"recommenders_can_see_organization_members": false,
"recommenders_can_see_organization_eligibility_profile": true,
"show_application_to_recommender": true,
"recommenders_can_see_organization_profile": true,
"tasks_visible_to_recommender": "all",
"recommenders_can_see_application_members": false,
"open_timestamp": "2023-01-01T00:00:00Z",
"tasks_visible_to_applicant": "all",
"program": \{
"id": 12345,
"name": "Scholarship Program 2023"
\},
"default_status": "In Progress",
"completion_message": "Thank you for submitting your application.",
"recommenders_can_see_organization_customfields": true,
"all_tasks_visible_to_recommender": true,
"id": 67890,
"edit_after_submit": false,
"recommendation_complete_message": "Thank you for submitting your recommendation.",
"organization_customfields_visible_to_recommenders": [
"org_field1",
"org_field2"
]
}
],
"next": "https://api.surveymonkey.com/v3/apply/stages?page=2&per_page=10",
"previous": null,
"num_pages": 3,
"page": 1,
"per_page": 10,
"count": 25,
"filters_applied": {
"A": "active"
},
"sort": "index:asc"
}
Raw HTTP request (advanced)
Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. Sample Input
{
"method": "POST",
"url": {
"endpoint": "/applications/123456/comments"
},
"headers": [
\{
"key": "Content-Type",
"value": "application/json"
\}
],
"query_parameters": [
\{
"key": "include_deleted",
"value": "false"
\}
],
"body": {
"raw": \{
"text": "This is a new comment on the application.",
"visibility": "admin"
\}
},
"include_raw_body": true,
"parse_response": "true"
}
Sample Output
{
"response": {
"status_code": 201,
"headers": \{
"Content-Type": "application/json",
"X-Request-Id": "abcd1234efgh5678"
\},
"body": {
"id": "987654",
"text": "This is a new comment on the application.",
"visibility": "admin",
"created_at": "2023-05-15T10:30:00Z",
"created_by": \{
"id": "user_12345",
"name": "John Doe"
\}
}
}
}
Update application
Update an application. Sample Input
{
"application_id": 12345,
"title": "Updated Scholarship Application",
"state": "0",
"current_stage": 2,
"program_id": 789,
"organization_id": 101,
"application_custom_fields": [
\{
"id": 1,
"value": "Bachelor's Degree"
\},
\{
"id": 2,
"value": "3.8"
\}
]
}
Sample Output
{
"id": 12345,
"applicant": \{
"id": 67890,
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@example.com"
\},
"average_score": 85.5,
"collaborators": [
\{
"first_name": "Jane",
"last_name": "Smith",
"email": "janesmith@example.com",
"id": 54321
\}
],
"created_at": "2023-05-01T10:30:00Z",
"current_stage": \{
"id": 2,
"title": "Review"
\},
"custom_fields": [
\{
"id": 1,
"name": "Education Level",
"value": "Bachelor's Degree"
\},
\{
"id": 2,
"name": "GPA",
"value": "3.8"
\}
],
"decision": \{
"id": 987,
"decision": 1,
"awarded": "10000"
\},
"labels": [
\{
"id": 111,
"name": "High Priority"
\}
],
"notes": [
{
"id": 222,
"author": \{
"id": 333,
"first_name": "Alice",
"last_name": "Johnson",
"email": "alicejohnson@example.com"
\},
"author_role": 2,
"content": "Strong candidate, recommend for interview.",
"edited": false,
"created_at": "2023-05-02T14:45:00Z",
"is_private": true,
"updated_at": "2023-05-02T14:45:00Z"
}
],
"organization": \{
"id": 101,
"name": "ABC University"
\},
"overall_score": 88,
"program": \{
"id": 789,
"name": "STEM Scholarship Program"
\},
"reference_id": "STEM2023-12345",
"state": 0,
"status": 1,
"title": "Updated Scholarship Application",
"updated_at": "2023-05-03T09:15:00Z",
"weighted_score": 87.2,
"last_submitted_at": "2023-05-01T16:20:00Z"
}
DDL operations
List application tasks (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
{
"tasks": [
\{
"id": "123456",
"name": "Personal Information",
"type": "form",
"status": "complete"
\},
\{
"id": "789012",
"name": "Essay Questions",
"type": "form",
"status": "incomplete"
\},
\{
"id": "345678",
"name": "Upload Resume",
"type": "upload",
"status": "not_started"
\},
\{
"id": "901234",
"name": "Reference Check",
"type": "reference",
"status": "in_progress"
\}
]
}
List applications (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
{
"applications": [
\{
"id": "1234567890",
"name": "John Doe",
"email": "johndoe@example.com",
"status": "submitted",
"submission_date": "2023-05-15T10:30:00Z",
"program": "Summer Internship 2023"
\},
\{
"id": "0987654321",
"name": "Jane Smith",
"email": "janesmith@example.com",
"status": "in_review",
"submission_date": "2023-05-14T14:45:00Z",
"program": "Graduate Fellowship 2023"
\},
\{
"id": "5678901234",
"name": "Alex Johnson",
"email": "alexjohnson@example.com",
"status": "approved",
"submission_date": "2023-05-13T09:15:00Z",
"program": "Research Grant 2023"
\}
],
"total_count": 3,
"page": 1,
"page_size": 50
}
List organizations (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
[
\{
"id": "123456",
"name": "Acme Corporation"
\},
\{
"id": "789012",
"name": "TechSolutions Inc."
\},
\{
"id": "345678",
"name": "Global Innovations Ltd."
\}
]
List programs (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
[
\{
"id": "123456",
"name": "Summer Internship Program"
\},
\{
"id": "789012",
"name": "Graduate Research Fellowship"
\},
\{
"id": "345678",
"name": "Community Grant Initiative"
\},
\{
"id": "901234",
"name": "Scholarship for STEM Students"
\}
]
List stages (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
[
\{
"id": "1234567890",
"name": "Application Review",
"description": "Initial review of submitted applications",
"position": 1,
"type": "review",
"is_active": true,
"created_at": "2023-05-15T10:30:00Z",
"updated_at": "2023-05-15T10:30:00Z"
\},
\{
"id": "2345678901",
"name": "Interview",
"description": "Conduct interviews with shortlisted candidates",
"position": 2,
"type": "interview",
"is_active": true,
"created_at": "2023-05-15T10:31:00Z",
"updated_at": "2023-05-15T10:31:00Z"
\},
\{
"id": "3456789012",
"name": "Final Decision",
"description": "Make final selection of successful applicants",
"position": 3,
"type": "decision",
"is_active": true,
"created_at": "2023-05-15T10:32:00Z",
"updated_at": "2023-05-15T10:32:00Z"
\}
]
List task files (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
{
"files": [
\{
"id": "file_123456",
"name": "project_proposal.pdf",
"size": 2048576,
"created_at": "2023-05-15T10:30:00Z",
"updated_at": "2023-05-15T10:30:00Z",
"content_type": "application/pdf",
"url": "https://api.surveymonkey.com/v3/files/file_123456"
\},
\{
"id": "file_789012",
"name": "budget_spreadsheet.xlsx",
"size": 1024288,
"created_at": "2023-05-14T14:45:00Z",
"updated_at": "2023-05-14T14:45:00Z",
"content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"url": "https://api.surveymonkey.com/v3/files/file_789012"
\},
\{
"id": "file_345678",
"name": "team_photo.jpg",
"size": 3145728,
"created_at": "2023-05-13T09:15:00Z",
"updated_at": "2023-05-13T09:15:00Z",
"content_type": "image/jpeg",
"url": "https://api.surveymonkey.com/v3/files/file_345678"
\}
]
}