> ## Documentation Index > Fetch the complete documentation index at: https://docs.modernloop.io/llms.txt > Use this file to discover all available pages before exploring further. # List candidates > Returns paginated candidate summaries with contact details, hiring-team assignments, ATS metadata, and anonymization state. Combine IDs, email, name, ATS, and record-timestamp filters to narrow results; every supplied filter is applied together. Anonymized candidates return redacted PII, and the returned cursor continues the same filtered result set. **Beta**: this endpoint may change or be removed without notice while in beta. There is no compatibility promise until it reaches general availability. ## OpenAPI ````yaml /openapi.json get /v1/candidates openapi: 3.1.0 info: title: ModernLoop Platform API version: 0.1.0 description: The ModernLoop Platform API for managing recruiting workflows. contact: email: support@modernloop.io servers: - url: https://api.modernloop.io security: [] tags: - name: Application - name: Candidate - name: Interview Event - name: Interview Module - name: Interviewer - name: Job - name: Job Stage - name: Organization - name: Schedule - name: Scheduling Task - name: Task Queue - name: Template paths: /v1/candidates: get: tags: - Candidate summary: List candidates description: >- Returns paginated candidate summaries with contact details, hiring-team assignments, ATS metadata, and anonymization state. Combine IDs, email, name, ATS, and record-timestamp filters to narrow results; every supplied filter is applied together. Anonymized candidates return redacted PII, and the returned cursor continues the same filtered result set. operationId: listCandidates parameters: - schema: type: string description: >- Opaque pagination cursor from the previous page's pagination.next_cursor, bound to the same query filters. required: false description: >- Opaque pagination cursor from the previous page's pagination.next_cursor, bound to the same query filters. name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 25 description: Page size. Must be between 1 and 100; defaults to 25. required: false description: Page size. Must be between 1 and 100; defaults to 25. name: limit in: query - schema: type: - array - 'null' items: type: string pattern: >- ^(?:can_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ description: >- a candidate ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive. example: can_a1b2c3d4e5f64789a1b2c3d4e5f64789 description: Comma-separated list of IDs; maximum 100 values. required: false description: Comma-separated list of IDs; maximum 100 values. name: ids in: query style: form explode: false - schema: type: string description: >- Case-insensitive exact match on candidate email; combines with other filters using AND. required: false description: >- Case-insensitive exact match on candidate email; combines with other filters using AND. name: email in: query - schema: type: string description: >- Case-insensitive substring match on candidate name; combines with other filters using AND. required: false description: >- Case-insensitive substring match on candidate name; combines with other filters using AND. name: name in: query - schema: type: - array - 'null' items: type: string description: >- Matches candidates whose ATS ID is one of these exact values; combines with other filters using AND. required: false description: >- Matches candidates whose ATS ID is one of these exact values; combines with other filters using AND. name: ats_ids in: query style: form explode: false - schema: type: string enum: - GREENHOUSE - ASHBY - LEVER - WORKDAY - SMARTRECRUITERS - GEM - KOMBO description: Filters by ATS provider. required: false description: Filters by ATS provider. name: ats_type in: query - schema: type: string format: date-time description: Filters records created at or after this timestamp. required: false description: Filters records created at or after this timestamp. name: created_at_gte in: query - schema: type: string format: date-time description: Filters records created at or before this timestamp. required: false description: Filters records created at or before this timestamp. name: created_at_lte in: query - schema: type: string format: date-time description: Filters records updated at or after this timestamp. required: false description: Filters records updated at or after this timestamp. name: updated_at_gte in: query - schema: type: string format: date-time description: Filters records updated at or before this timestamp. required: false description: Filters records updated at or before this timestamp. name: updated_at_lte in: query responses: '200': description: Success content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Candidate' pagination: $ref: '#/components/schemas/Pagination' required: - data - pagination '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '410': description: Gone content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: Candidate: type: object properties: id: type: string pattern: ^can_[0-9a-f]{32}$ description: >- Canonical candidate ID (can_ followed by 32 lowercase hexadecimal UUID characters). example: can_a1b2c3d4e5f64789a1b2c3d4e5f64789 name: type: object properties: full: type: string given: type: - string - 'null' family: type: - string - 'null' required: - full - given - family primary_email: type: - string - 'null' format: email additional_emails: type: - array - 'null' items: type: string format: email description: >- Additional candidate email addresses. Null means PII was redacted because the candidate is anonymized; an empty array means no additional email addresses. phone_numbers: type: - array - 'null' items: type: string description: >- Candidate phone numbers. Null means PII was redacted because the candidate is anonymized; an empty array means no phone numbers. timezone: type: - string - 'null' linkedin_url: type: - string - 'null' format: uri preferred_name: type: - string - 'null' recruiter: type: - object - 'null' properties: id: type: string pattern: ^emp_[0-9a-f]{32}$ description: >- Canonical employee ID (emp_ followed by 32 lowercase hexadecimal UUID characters). example: emp_a1b2c3d4e5f64789a1b2c3d4e5f64789 name: type: string required: - id - name coordinator: type: - object - 'null' properties: id: type: string pattern: ^emp_[0-9a-f]{32}$ description: >- Canonical employee ID (emp_ followed by 32 lowercase hexadecimal UUID characters). example: emp_a1b2c3d4e5f64789a1b2c3d4e5f64789 name: type: string required: - id - name ats: type: - object - 'null' properties: type: type: string enum: - GREENHOUSE - ASHBY - LEVER - WORKDAY - SMARTRECRUITERS - GEM - KOMBO id: type: string required: - type - id anonymized: type: boolean created_at: type: string format: date-time description: ISO 8601 timestamp. updated_at: type: string format: date-time description: ISO 8601 timestamp. app_url: type: string format: uri required: - id - name - primary_email - additional_emails - phone_numbers - timezone - linkedin_url - preferred_name - recruiter - coordinator - ats - anonymized - created_at - updated_at - app_url Pagination: type: object properties: next_cursor: type: - string - 'null' required: - next_cursor ErrorResponse: type: object properties: error: type: object properties: code: type: string enum: - UNAUTHENTICATED - API_ACCESS_DISABLED - SCOPE_MISSING - INSUFFICIENT_SCOPE - VALIDATION_FAILED - INVALID_CURSOR - PAYLOAD_TOO_LARGE - NOT_FOUND - NOT_FOUND_MAY_BE_SYNCING - CANDIDATE_ANONYMIZED - TASK_STAGE_NOT_SCHEDULABLE - DUPLICATE_REQUEST_OPEN - IDEMPOTENCY_KEY_REQUIRED - IDEMPOTENCY_KEY_REUSED - PREVIEW_EXPIRED - PREVIEW_STALE - RATE_LIMITED - CONFLICT - NOT_IMPLEMENTED - INTERNAL - UPSTREAM_TIMEOUT message: type: string docs_url: type: string format: uri required: - code - message required: - error securitySchemes: bearerAuth: type: http scheme: bearer description: API tokens are passed as Bearer tokens. ````