> ## Documentation Index > Fetch the complete documentation index at: https://developer.jobmojito.com/llms.txt > Use this file to discover all available pages before exploring further. # List candidates > Paginated list of a merchant's candidates (the admin-portal candidates list), scoped to the merchant from the JWT or the optional merchant_id override. Capped at 1000 records per page. ## OpenAPI ````yaml https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-list openapi: 3.1.0 info: title: JobMojito API version: 1.0.0 description: >- Public API for JobMojito, served by Supabase Edge Functions. Authenticate with a Supabase JWT access token via the Authorization header. servers: - url: https://cool.jobmojito.com/functions/v1 description: Production security: [] tags: - name: Interviews description: >- Create, configure and manage interview / coaching / assessment definitions. - name: Results description: >- Interview results, transcripts, reports, re-attempt requests and analytics. - name: Candidates description: List and manage candidates. - name: Knowledge base description: Upload documents used to generate knowledge-base interviews. - name: Resume & Form verification description: Pre-screen candidates from resumes and forms. - name: Admin description: >- Account administration — invite team/coaching users, manage sub-merchants and avatar templates. paths: /merchant-candidate-list: get: tags: - Candidates summary: List candidates description: >- Paginated list of a merchant's candidates (the admin-portal candidates list), scoped to the merchant from the JWT or the optional merchant_id override. Capped at 1000 records per page. parameters: - schema: type: string format: uuid description: >- Optional merchant to scope the results to. Honoured only when the caller is an admin or a sub-merchant operator; otherwise the merchant from the JWT is always used. example: 28106cba-1c27-4e53-b149-32113e5e8e31 required: false name: merchant_id in: query - schema: type: string enum: - interview - pre-screening - no-action - leads - '' description: >- Filter candidates by recent activity. Omit (or empty) to include all. example: interview required: false name: tab in: query - schema: type: string enum: - invited - registered description: >- Filter by how the candidate entered: invited or self-registered. Omit for both. example: registered required: false name: source in: query - schema: type: string enum: - name_accending - name_decending - created_at_newest - created_at_oldest default: created_at_newest description: Sort order of the result set. example: created_at_newest required: false name: order_by in: query - schema: type: string description: Case-insensitive search on candidate name or email. required: false name: filter_text in: query - schema: type: string description: Filter by the candidate emoji marker. required: false name: filter_emoji in: query - schema: type: integer minimum: 1 maximum: 1000 default: 50 description: Maximum number of records to return (1–1000). example: 50 required: false name: limit in: query - schema: type: integer nullable: true minimum: 0 default: 0 description: Number of records to skip from the start of the result set. example: 0 required: false name: offset in: query responses: '200': description: A page of candidates with pagination metadata. content: application/json: schema: $ref: '#/components/schemas/MerchantCandidateListResponse' '401': description: Missing or invalid access token. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Caller is not permitted to read this merchant. content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Validation error. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Server error. content: application/json: schema: $ref: '#/components/schemas/Error' security: - bearerAuth: [] components: schemas: MerchantCandidateListResponse: type: object properties: data: type: array items: type: object properties: id: type: string description: Candidate (profile_interview) id. profile_id: type: string nullable: true description: Underlying profile id. merchant_id: type: string nullable: true description: Owning merchant id. name: type: string nullable: true description: Candidate name. email: type: string nullable: true description: Candidate email. email_auth: type: string nullable: true description: Auth email (login). emoji: type: string nullable: true description: Emoji marker. external_id: type: string nullable: true description: External identifier. status: type: string nullable: true description: Status (active/invited/deleted). phone_number: type: string nullable: true description: Phone number. linked_in: type: string nullable: true description: LinkedIn URL. physical_address: type: string nullable: true description: Physical address. mojito_language_code: type: string nullable: true description: Platform language code. avatar_url: type: string nullable: true description: Avatar image URL. avatar_local_path: type: string nullable: true description: Avatar storage path. kyc_image_local_path: type: string nullable: true description: KYC image storage path. kyc_processing_status: type: string nullable: true description: KYC processing status. interview_count: type: number nullable: true description: Number of interviews taken. pre_screening_count: type: number nullable: true description: Number of pre-screenings taken. public_avatar_count: type: number nullable: true description: Number of public-avatar conversations. interview_last: type: string nullable: true description: Most recent interview timestamp (ISO 8601). last_login_at: type: string nullable: true description: Last login timestamp (ISO 8601). created_at: type: string nullable: true description: Creation timestamp (ISO 8601). updated_at: type: string nullable: true description: Last update timestamp (ISO 8601). deleted_at: type: string nullable: true description: Deletion timestamp (ISO 8601), if deleted. required: - id additionalProperties: nullable: true description: The merchant's candidates for this page. pagination: $ref: '#/components/schemas/Pagination' required: - data - pagination Error: type: object properties: error: type: string example: Field is required. name: type: string example: interview_result_id required: - error Pagination: type: object properties: total: type: integer description: Total matching records across all pages. example: 137 limit: type: integer description: Page size used for this response. example: 50 offset: type: integer description: Offset used for this response. example: 0 has_more: type: boolean description: >- True when more records exist beyond this page (offset + returned < total). example: true required: - total - limit - offset - has_more securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: 'Supabase JWT access token, passed as `Authorization: Bearer `.' ````