Queue Pending Mobility Survey Export

Queue an async Excel export of employees pending a mobility survey response across a holding’s whole organization tree

GET /v2/employees/pending-survey/download

Queue Pending Mobility Survey Export

JavaScript

const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v2/employees/pending-survey/download', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "processing_job_id": "<string>"
}

Queue Pending Mobility Survey Export

Queues an asynchronous export listing every employee who has not yet responded to a mobility survey, across the header organization plus every accepted, enabled descendant in its organization tree (recursively). Intended for a holding organization checking on outstanding responses across all of its subsidiaries at once — the group scope is always applied and cannot be narrowed to a single organization.

“Pending” means the employee record has status = loading and enabled = true — the state a survey send/resend leaves an employee in until they respond. Employees without an email are excluded, since there is no way to follow up with them.

This endpoint only enqueues the export — it creates a PENDING processing job, fires an event for a background worker to build the .xlsx and upload it, and returns immediately with processing_job_id. Poll the processing job (or wait for the in-app notification / email) to retrieve the download link once it completes. If there are no pending employees, the export still completes with a file containing just the header row.

Request

Headers

x-api-key · string · required

Your API key for authentication

Example: sk_live_1234567890abcdef

x-organization-id · string · required

UUID of the holding (or any) organization. The export always spans this organization plus its whole descendant tree.

Example: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Response

processing_job_id · string

UUID of the created processing job. Poll GET /processing_jobs/{processing_job_id}/download-url until the job completes to retrieve a presigned download URL for the .xlsx file.

The completed workbook has a single sheet with columns:

Column	Description
Email	Employee’s email address
Name	Employee’s name
Organization	Name of the organization (within the tree) the employee belongs to
Survey sent date	Date the survey was sent (date only, no time)

Column headers and the worksheet name are localized to the requesting user’s stored language (Spanish or English currently; Spanish is the fallback).

Example

cURL

curl -X GET "https://api.dcycle.io/v2/employees/pending-survey/download" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

Successful Response

{
  "processing_job_id": "550e8400-e29b-41d4-a716-446655440000"
}

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

403 Forbidden

Cause: The authenticated user is not a member of the organization

{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}

404 Not Found

Cause: Organization not found

{"code": "ORGANIZATION_NOT_FOUND", "detail": "Organization with id=UUID('...') not found"}

Related Endpoints

List Employees (V2)

List employees with group-view filtering, including by status

Bulk Delete by Filters

Bulk-delete employees matching the same group-view filters