arazzo: 1.0.1
info:
  title: Coresignal Employee Search and Collect
  summary: Search the Multi-source Employee API by filters, then collect the full top-matching employee profile.
  description: >-
    The canonical Coresignal employee pattern. The workflow submits a structured
    employee filter to the Multi-source Employee API search endpoint, which
    returns an array of matching employee IDs, and then collects the full
    enriched profile for the first matching ID. Every step spells out its request
    inline, including the apikey authentication header and the search filter body,
    so the flow can be read and executed without opening the underlying OpenAPI
    description.
  version: 1.0.0
sourceDescriptions:
- name: employeeApi
  url: ../openapi/coresignal-multi-source-employee-api-openapi.yml
  type: openapi
workflows:
- workflowId: employee-search-collect
  summary: Filter employees and collect the full profile for the best match.
  description: >-
    Posts an employee filter to the search endpoint and collects the full
    employee profile for the first returned ID.
  inputs:
    type: object
    required:
    - apikey
    properties:
      apikey:
        type: string
        description: Coresignal API key sent in the apikey header.
      title:
        type: string
        description: Job title to filter employees on.
      country:
        type: string
        description: Country to filter employees on.
      industry:
        type: string
        description: Industry to filter employees on.
      active_experience_company_name:
        type: string
        description: Current employer company name to filter on.
      active_experience_title:
        type: string
        description: Current role title to filter on.
  steps:
  - stepId: searchEmployees
    description: >-
      Search employee records using a structured filter. Returns an array of
      matching Coresignal employee IDs.
    operationId: searchEmployeesByFilter
    parameters:
    - name: apikey
      in: header
      value: $inputs.apikey
    requestBody:
      contentType: application/json
      payload:
        title: $inputs.title
        country: $inputs.country
        industry: $inputs.industry
        active_experience_company_name: $inputs.active_experience_company_name
        active_experience_title: $inputs.active_experience_title
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      employeeIds: $response.body
      topEmployeeId: $response.body#/0
  - stepId: collectEmployee
    description: >-
      Retrieve the full enriched employee profile for the first matching ID
      returned by the search.
    operationId: collectEmployee
    parameters:
    - name: apikey
      in: header
      value: $inputs.apikey
    - name: id
      in: path
      value: $steps.searchEmployees.outputs.topEmployeeId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      employeeId: $response.body#/id
      fullName: $response.body#/full_name
      title: $response.body#/title
      location: $response.body#/location
  outputs:
    employeeIds: $steps.searchEmployees.outputs.employeeIds
    fullName: $steps.collectEmployee.outputs.fullName
    title: $steps.collectEmployee.outputs.title