--- updatedAt: 2026-05-27T10:11:03.000Z agentTools: projectIndex: https://developers.manatal.com/llms.txt --- # /candidates/ Retrieve all candidates ordered alphabetically. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Manatal Open API", "description": "Manatal Open API documentation and API reference", "version": "v3" }, "security": [ { "api_key": [] } ], "paths": { "/candidates/": { "get": { "operationId": "candidates_list", "description": "Retrieve all candidates ordered alphabetically.", "parameters": [ { "name": "id", "in": "query", "description": "", "required": false, "schema": { "type": "integer" } }, { "name": "full_name", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "creator_id", "in": "query", "description": "", "required": false, "schema": { "type": "integer" } }, { "name": "owner_id", "in": "query", "description": "", "required": false, "schema": { "type": "integer" } }, { "name": "source_type", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "phone_number", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "birth_date__gte", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "birth_date__lte", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "latest_degree", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "latest_university", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "current_company", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "current_position", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "candidate_tags", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "candidate_industries", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "candidate_location", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "created_at__gte", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "created_at__lte", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "updated_at__gte", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "updated_at__lte", "in": "query", "description": "", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "schema": { "type": "integer" } }, { "name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri", "nullable": true }, "previous": { "type": "string", "format": "uri", "nullable": true }, "results": { "type": "array", "items": { "required": [ "full_name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "external_id": { "title": "External id", "description": "Id of the candidate in the API consumer systems", "type": "string", "maxLength": 255, "nullable": true }, "full_name": { "title": "Full name", "description": "Full name of the candidate", "type": "string", "maxLength": 255, "minLength": 1 }, "creator": { "title": "Creator", "description": "User who created the candidate", "type": "integer", "readOnly": true }, "owner": { "title": "Owner", "description": "ID of the owner of the candidate - default to creator if none is provided", "type": "integer", "nullable": true }, "source_type": { "title": "Source type", "description": "Origin of the candidate", "type": "string", "enum": [ "sourced", "applied", "referred", "agency", "other" ] }, "source_other": { "title": "Source other", "description": "Field to add manual information to the source if the source_type is other", "type": "string", "maxLength": 255, "nullable": true }, "source_details": { "title": "Source details", "description": "The source details of the candidate", "type": "object", "properties": { "type": { "type": "string" }, "channel": { "type": "string" }, "portal": { "type": "object", "properties": { "id": { "type": "integer" }, "display_name": { "type": "string" } } }, "referrer": { "type": "object", "properties": { "id": { "type": "integer" }, "full_name": { "type": "string" } } }, "agency": { "type": "object", "properties": { "id": { "type": "integer" }, "given_name": { "type": "string" } } }, "other_label": { "type": "string" }, "reference": { "type": "string" } } }, "consent": { "title": "Consent", "description": "Whether the candidate gave permission to use his data (GDPR,Brazil's LGPD, USA´s CCPA ...)", "type": "boolean", "nullable": true }, "consent_date": { "title": "Consent date", "description": "Date at which the candidate gave his consent", "type": "string", "format": "date-time", "readOnly": true }, "picture": { "title": "Picture", "description": "Link to the candidate picture", "type": "string", "readOnly": true, "format": "uri" }, "email": { "title": "Email", "description": "Candidate email", "type": "string", "format": "email", "maxLength": 254, "nullable": true }, "resume": { "title": "Resume", "description": "Link to the candidate resume", "type": "string", "readOnly": true, "minLength": 1 }, "phone_number": { "title": "Phone number", "description": "Candidate phone number", "type": "string", "maxLength": 255, "nullable": true }, "gender": { "title": "Gender", "description": "Gender of the candidate", "type": "string", "enum": [ "male", "female", "other", "unknown" ], "nullable": true }, "birth_date": { "title": "Birth date", "description": "Candidate birth date", "type": "string", "format": "date", "nullable": true }, "address": { "title": "Address", "description": "Full address of the candidate", "type": "string", "maxLength": 255 }, "zipcode": { "title": "Zipcode", "description": "Code for the city of the address field", "type": "string", "maxLength": 255 }, "latest_degree": { "title": "Latest degree", "description": "Latest degree obtained by the candidate", "type": "string", "maxLength": 255, "nullable": true }, "latest_university": { "title": "Latest university", "description": "Latest university the candidate graduated from", "type": "string", "maxLength": 255, "nullable": true }, "current_company": { "title": "Current company", "description": "Company where the candidate currently works", "type": "string", "maxLength": 255, "nullable": true }, "current_department": { "title": "Current department", "description": "Department where the candidate works", "type": "string", "maxLength": 255, "nullable": true }, "current_position": { "title": "Current position", "description": "Position of the candidate at his current job", "type": "string", "maxLength": 255, "nullable": true }, "candidate_location": { "title": "Candidate location", "description": "Location of the candidate", "type": "string", "nullable": true }, "candidate_tags": { "title": "Candidate tags", "description": "List of tags associated with the candidate", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "tag_id": { "type": "integer" }, "tag_name": { "type": "string" }, "tag_color": { "type": "string" } } } }, "candidate_industries": { "title": "Candidate industries", "description": "List of industries associated with the candidate", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "industry": { "type": "integer" }, "industry_name": { "type": "string" }, "candidate": { "type": "integer" }, "creator_name": { "type": "string" } } } }, "description": { "title": "Description", "description": "Description of the candidate - can only input text here.", "type": "string" }, "hash": { "title": "Hash", "description": "Unique hash of the candidate", "type": "string", "readOnly": true, "minLength": 1 }, "custom_fields": { "title": "Custom fields", "description": "Candidate values for custom fields defined in Manatal.", "type": "object" }, "created_at": { "title": "Created at", "description": "Date at which the candidate was created", "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "title": "Updated at", "type": "string", "format": "date-time", "readOnly": true } } } } } } } } } }, "tags": [ "candidates" ] }, "parameters": [] } }, "servers": [ { "url": "https://api.manatal.com/open/v3" } ], "components": { "securitySchemes": { "api_key": { "in": "header", "name": "Authorization", "x-default": "Token ", "type": "apiKey" } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true, "samples-enabled": true } } ```