> ## Documentation Index > Fetch the complete documentation index at: https://docs.userecord.io/llms.txt > Use this file to discover all available pages before exploring further. # List workflows > List your organisation’s blue-collar workflows (made here or in the playground). **Scope:** `workflows:read` or `workflows:write` ## OpenAPI ````yaml /blue-collar-api/api-reference/openapi.json get /workflows openapi: 3.1.0 info: title: Record Blue Collar API version: 1.0.0 description: >- Run Record candidate verification from your own system. You need two things: your **key id** and your **secret**. Everything else is generated. See Authentication for how. servers: - url: https://api-bc.userecord.io/api/v1/partner description: Blue Collar API security: [] tags: - name: Skills description: The skill taxonomy, read live a page at a time - name: Skill requests description: Ask Record to add a missing skill - name: Lookups description: >- Lookups for filling in a job mandate: places in India, the countries an abroad job can be in, and the employment types and shifts the playground offers - name: Workflows description: >- Your organisation's blue-collar workflows (read all; change and soft-delete only the ones you created) - name: Job mandates description: >- Your organisation's job mandates, addressed by Record's mandate_id (read all; change only the ones you created) - name: Campaigns description: Contact candidates for one of your jobs and verify them. Spends credits - name: Results description: >- What Record collected from each candidate: status (pending, completed, declined, failed) and an output of answers and verdicts - name: Events description: >- Pull your result events and acknowledge them: the safety net behind the webhook, and a way to receive results without exposing a URL - name: Webhooks description: >- Endpoints that Record POSTs result events to: signed, retried until you acknowledge, replayable - name: Analytics description: >- The workflow Overview analytics of the Record playground: funnel, channels, follow-ups, calls, drop-offs, languages (read-only, scope analytics:read) paths: /workflows: get: tags: - Workflows summary: List workflows description: >- List your organisation’s blue-collar workflows (made here or in the playground). **Scope:** `workflows:read` or `workflows:write` operationId: listWorkflows parameters: - name: status in: query required: false schema: type: string enum: - active - inactive - draft - archived example: active - name: include_archived in: query required: false description: Archived workflows are left out unless true schema: type: string enum: - 'true' - 'false' default: 'false' example: 'false' - name: updated_since in: query required: false description: ISO 8601 date-time schema: type: string format: date-time - name: limit in: query required: false description: 1 to 100, default 50 schema: type: integer minimum: 1 maximum: 100 default: 50 example: 50 - name: cursor in: query required: false description: The next_cursor of the previous page schema: type: string maxLength: 512 responses: '200': description: One page, oldest first content: application/json: schema: type: object properties: success: const: true type: boolean message: type: string data: type: object properties: items: type: array items: type: object properties: workflow_id: type: string external_id: anyOf: - type: string - type: 'null' name: type: string collar: const: blue type: string status: type: string enum: - active - inactive - draft - archived default_methods: type: array items: type: string enum: - data_enrichment - skill_verification - interest_collection verification_methods: type: array items: type: object properties: type: type: string enum: - scenario-questions - ai-phone-call description: >- scenario-questions = the scenario question round; ai-phone-call = the AI phone call enabled: type: boolean description: >- Read-only: Record switches both methods on for every workflow, so you do not send it. Empty only on a workflow created before this field was stored. delivery: type: object properties: whatsapp: type: boolean voice_call: type: boolean sms_backup: type: boolean schedule: type: object properties: start_time: type: string end_time: type: string days: type: array items: type: string timezone: type: string max_retries: type: integer retry_after_hours: type: integer is_external: type: boolean description: >- true when the workflow was created through the Partner API, false when it was made in the Record playground created_at: type: string updated_at: type: string count: type: integer description: How many items this page holds total: anyOf: - type: integer - type: 'null' description: >- How many items match your filters across all pages. null when that cannot be counted cheaply: a filter worked out per item (status, progress) on a list that is large next_cursor: anyOf: - type: string - type: 'null' description: >- Pass as `cursor` for the next page; null on the last page has_more: type: boolean description: >- true while there is a next page (with a status or progress filter that page can still come back empty) example: success: true data: items: - workflow_id: WF_BG_261009101530123K7M2P9Q4X7R5T8 external_id: wf-warehouse-chennai name: Warehouse associates - Chennai collar: blue status: active default_methods: - data_enrichment - skill_verification verification_methods: - type: scenario-questions enabled: true - type: ai-phone-call enabled: true delivery: whatsapp: true voice_call: true sms_backup: false schedule: start_time: '09:00' end_time: '19:00' days: - mon - tue - wed - thu - fri - sat timezone: Asia/Kolkata max_retries: 3 retry_after_hours: 6 is_external: true created_at: '2026-10-09T10:15:30.123Z' updated_at: '2026-10-09T10:15:30.123Z' count: 1 total: 1 next_cursor: null has_more: false '400': description: '`VALIDATION_FAILED`: Bad `cursor`, or `limit` above 100.' content: application/json: schema: $ref: '#/components/schemas/Error' security: - ApiKey: [] SecretKey: [] x-codeSamples: - lang: bash label: cURL source: >- pcall GET "/api/v1/partner/workflows?status=active&include_archived=false&limit=50" - lang: javascript label: JavaScript source: >- const res = await call("GET", "/api/v1/partner/workflows?status=active&include_archived=false&limit=50"); const { data } = await res.json(); - lang: python label: Python source: >- res = call("GET", "/api/v1/partner/workflows?status=active&include_archived=false&limit=50") data = res.json()["data"] components: schemas: Error: type: object properties: success: const: false type: boolean error: type: object properties: code: type: string enum: - VALIDATION_FAILED - LIMIT_EXCEEDED - UNAUTHORIZED - SCOPE_MISSING - FORBIDDEN - HTTPS_REQUIRED - NOT_FOUND - CONFLICT - WORKFLOW_IN_USE - INSUFFICIENT_CREDITS - IDEMPOTENCY_KEY_REQUIRED - IDEMPOTENCY_KEY_REUSED - IDEMPOTENCY_IN_PROGRESS - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - COOLDOWN - DAILY_CAP - SERVICE_DISABLED - SERVER_ERROR message: type: string details: type: array items: type: object properties: path: type: string message: type: string request_id: type: string description: Quote it to Record support securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: Your key id, `VFN_TEST_…` or `VFN_LIVE_…`. Sent on every request. SecretKey: type: apiKey in: header name: x-secret-key description: >- Your secret, `VFN_SK_…`. **Not a real header, and never sent to the API.** It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send `x-api-key`, `x-timestamp` and `x-signature` (see Authentication). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.