Purple Talent API Documentation
Machine-readable OpenAPI 3.0 specification: https://marketplace.moveworks.com/api/purple-suite/purple-talent/openapi.json
The consolidated all-apps document at https://marketplace.moveworks.com/api/purple-suite/openapi.json can be narrowed to this app with ?apps=purple-talent, or combined with other apps comma-separated (e.g. ?apps=purple-talent,itsm).
Overview
Endpoints
POST /api/purple-suite/purple-talent/search_people
Parse a free-text candidate search into criteria and return a search_parameters_ref (search_people)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
querystring
Responses
200- Parse a free-text candidate search into criteria and return a search_parameters_ref (search_people)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/estimate_people_pool
Return the candidate pool size for a search_parameters_ref (estimate_people_pool)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
search_parameters_refstringdata_sourcestring
Responses
200- Return the candidate pool size for a search_parameters_ref (estimate_people_pool)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/analyze_people_pool
Return a term-frequency breakdown (e.g. skills, titles) over a search_parameters_ref's pool (analyze_people_pool)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
search_parameters_refstringfieldsarrayarray of:
field_analysis_limitnumberdata_sourcestring
Responses
200- Return a term-frequency breakdown (e.g. skills, titles) over a search_parameters_ref's pool (analyze_people_pool)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/analyze_company_role_flow
Return hire/departure headline + top sources for a company + role scope, synchronously (analyze_company_role_flow)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
target_companystringdirectionstringrole_scopestringtitle_keywordsarrayarray of:
windowobjecttop_nnumber
Responses
200- Return hire/departure headline + top sources for a company + role scope, synchronously (analyze_company_role_flow)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/count_global_jobs
Count global job postings matching company/query/location/status filters (count_global_jobs)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
company_queriesarrayarray of:
querystringlocation_querystringstatus_codesarrayarray of:
Responses
200- Count global job postings matching company/query/location/status filters (count_global_jobs)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/global_jobs_by_query
Paginated search over the global job-postings corpus (global_jobs_by_query)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
querystringfiltersobjectpagenumberhits_per_pagenumberstrict_filter_validationboolean
Responses
200- Paginated search over the global job-postings corpus (global_jobs_by_query)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/find_tools
Search for available tools by name or description (find_tools)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
querystring
Responses
200- Search for available tools by name or description (find_tools)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/list_skills
Get the skill taxonomy and available skills (list_skills)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
limitnumber
Responses
200- Get the skill taxonomy and available skills (list_skills)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/load_skill
Load details for a specific skill (load_skill)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
skill_idstring
Responses
200- Load details for a specific skill (load_skill)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/resolve_company
Resolve company information by name or domain (resolve_company)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
companies_infoarrayarray of:
Responses
200- Resolve company information by name or domain (resolve_company)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/scout_people_pool
Advanced people pool search with filtering (scout_people_pool)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
querystringcompany_meta_refsarrayarray of:
Responses
200- Advanced people pool search with filtering (scout_people_pool)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/talent_pool_deep_research
Comprehensive talent pool analysis (talent_pool_deep_research)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
icp_idstring
Responses
200- Comprehensive talent pool analysis (talent_pool_deep_research)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/preview_people
Fetch individual candidate profiles (preview_people)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
search_parameters_refstringlimitnumber
Responses
200- Fetch individual candidate profiles (preview_people)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/company_metrics
Get aggregated company statistics (company_metrics)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
company_idstring
Responses
200- Get aggregated company statistics (company_metrics)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/analyze_company_workforce_trend
Time-series workforce trend analysis (analyze_company_workforce_trend)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
companystringyear_startnumberyear_endnumber
Responses
200- Time-series workforce trend analysis (analyze_company_workforce_trend)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/web_search
Search the web for information (web_search)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
querystringmax_searchesnumber
Responses
200- Search the web for information (web_search)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/create_artifact
Create and store an analysis artifact (create_artifact)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
artifact_typestringdataobject
Responses
200- Create and store an analysis artifact (create_artifact)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/create_project_from_search_parameters
Create a project from search parameters (create_project_from_search_parameters)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
search_parameters_refstringnamestringdescriptionstring
Responses
200- Create a project from search parameters (create_project_from_search_parameters)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/studio_list_workflows
List available workflow definitions (studio_list_workflows)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
runnable_onlyboolean
Responses
200- List available workflow definitions (studio_list_workflows)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/studio_run_workflow
Execute a workflow asynchronously (studio_run_workflow)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
workflow_keystringinputsobject
Responses
200- Execute a workflow asynchronously (studio_run_workflow)
application/jsonobject
400- Bad request
POST /api/purple-suite/purple-talent/studio_get_run_status
Poll the status of an executing workflow (studio_get_run_status)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
run_idstring required
Responses
200- Poll the status of an executing workflow
application/jsonobject
POST /api/purple-suite/purple-talent/wf__succession_planning_workflow_fbf487
Execute Succession Planning Workflow
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
inputsobject
Responses
200- Succession Planning Workflow execution result
application/jsonobject
POST /api/purple-suite/purple-talent/wf__role_talent_inflow_outflow_analysis_e80ffb
Execute Role Talent Inflow/Outflow Analysis
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Instance-ID | header | string | yes |
Request body
application/json — required
inputsobject
Responses
200- Role Talent Inflow/Outflow Analysis execution result
application/jsonobject