--- updatedAt: 2026-05-20T09:01:59.000Z --- Fetch the complete documentation index at: https://apidocs.hibob.com/llms.txt. Use this file to discover all available pages before exploring further. # Search candidate volunteer experiences Searches candidate volunteer experience records using filters and returns paginated results.

Testing notes:

# OpenAPI definition ```json { "openapi": "3.1.1", "info": { "title": "Bob Hiring API", "description": "Public API for accessing Bob Hiring data including Job Openings, Candidates, and Applications.", "license": { "name": "Proprietary", "url": "https://apidocs.hibob.com/docs/api-terms-of-use" }, "contact": { "name": "Hi Bob, Inc." }, "version": "1.0.0" }, "servers": [ { "url": "https://api.hibob.com/v1", "description": "Production" }, { "url": "https://api.sandbox.hibob.com/v1", "description": "Sandbox" } ], "x-readme": { "metrics-enabled": false }, "tags": [ { "name": "Candidates", "description": "Search and retrieve candidate data" } ], "paths": { "/hiring/candidate-volunteer-experiences/search": { "post": { "tags": [ "Candidates" ], "operationId": "post_hiring-candidate-volunteer-experiences-search", "summary": "Search candidate volunteer experiences", "description": "Searches candidate volunteer experience records using filters and returns paginated results.\n\n\n\n

Testing notes:

\n\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateVolunteerExperienceSearchRequest" }, "examples": { "basicSearch": { "summary": "Basic search - all volunteer records", "description": "Retrieve candidate volunteer experience records with core fields", "value": { "fields": [ "/candidateVolunteerExperience/id", "/candidateVolunteerExperience/organization", "/candidateVolunteerExperience/startDate", "/candidateVolunteerExperience/candidateId" ], "filters": [], "limit": 100 } }, "filteredSearch": { "summary": "Filter by candidate ID", "description": "Search with specific filter criteria", "value": { "fields": [ "/candidateVolunteerExperience/id", "/candidateVolunteerExperience/organization", "/candidateVolunteerExperience/startDate", "/candidateVolunteerExperience/candidateId" ], "filters": [ { "fieldId": "/candidateVolunteerExperience/candidateId", "operator": "equals", "values": [ 7247347 ] } ], "limit": 50 } } } } } }, "responses": { "200": { "description": "Successfully retrieved candidate volunteer experience records", "headers": { "X-RateLimit-Limit": { "description": "Maximum requests per minute", "schema": { "type": "integer", "example": 120 } }, "X-RateLimit-Remaining": { "description": "Remaining requests in current window", "schema": { "type": "integer", "example": 119 } }, "X-RateLimit-Reset": { "description": "Seconds until rate limit resets", "schema": { "type": "integer", "example": 60 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CandidateVolunteerExperienceSearchResponse" }, "examples": { "successResponse": { "summary": "Successful response", "value": { "items": [ { "/candidateVolunteerExperience/id": 5001, "/candidateVolunteerExperience/organization": "Red Cross", "/candidateVolunteerExperience/startDate": "2019-03-15", "/candidateVolunteerExperience/candidateId": 7247347 } ], "response_metadata": { "next_cursor": "eyJpZCI6MTIzNDU2Nzg5fQ==" } } } } } } }, "400": { "description": "Bad Request - Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "INVALID_ARGUMENT", "message": "Invalid field ID", "requestId": "a1b2c3d4e5f6" } } } }, "401": { "description": "Unauthorized - Invalid or missing credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden - IP not allowed or feature not enabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "FORBIDDEN", "message": "Access denied: IP address is not allowed", "requestId": "a1b2c3d4e5f6" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "code": "RATE_LIMITED", "message": "Rate limit exceeded. Try again in 45 seconds.", "requestId": "a1b2c3d4e5f6" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "Basic": [] } ], "x-internal": false } } }, "components": { "securitySchemes": { "Basic": { "type": "http", "scheme": "basic", "description": "Basic HTTP authentication using service user credentials" } }, "schemas": { "CandidateVolunteerExperienceSearchRequest": { "type": "object", "required": [ "fields" ], "default": { "fields": [ "/candidateVolunteerExperience/id", "/candidateVolunteerExperience/organization", "/candidateVolunteerExperience/startDate", "/candidateVolunteerExperience/candidateId" ], "filters": [], "limit": 100 }, "properties": { "fields": { "type": "array", "items": { "type": "string", "enum": [ "/candidateVolunteerExperience/id", "/candidateVolunteerExperience/organization", "/candidateVolunteerExperience/startDate", "/candidateVolunteerExperience/startDateDay", "/candidateVolunteerExperience/startDateMonth", "/candidateVolunteerExperience/startDateYear", "/candidateVolunteerExperience/endDate", "/candidateVolunteerExperience/endDateDay", "/candidateVolunteerExperience/endDateMonth", "/candidateVolunteerExperience/endDateYear", "/candidateVolunteerExperience/candidateId", "/candidateVolunteerExperience/applicationId" ] }, "description": "Required list of field IDs to include in the response (1–50 fields). The property must be provided; if omitted or not provided, the API returns an error. You must explicitly choose which fields to fetch. For all available field IDs, see the fields object defined on each item in the 200 response schema." }, "filters": { "type": "array", "items": { "type": "object", "required": [ "fieldId", "operator", "values" ], "properties": { "fieldId": { "type": "string", "enum": [ "/candidateVolunteerExperience/id", "/candidateVolunteerExperience/candidateId", "/candidateVolunteerExperience/applicationId" ], "description": "Field ID to filter by" }, "operator": { "type": "string", "enum": [ "equals", "notEqual", "greaterThan", "lessThan" ], "description": "Filter operator. Use 'equals'/'notEqual' for exact matching. Use 'greaterThan'/'lessThan' for date range filtering.\n" }, "values": { "type": "array", "items": { "type": [ "string", "number" ] } } } }, "default": [] }, "limit": { "type": "integer", "minimum": 1, "maximum": 200, "default": 100 }, "cursor": { "type": "string" }, "includeArchived": { "type": "boolean", "default": false } } }, "CandidateVolunteerExperienceSearchResponseObject": { "type": "object", "description": "Flat key-value map of field IDs to values. Only requested fields are included.", "properties": { "/candidateVolunteerExperience/id": { "type": "integer", "format": "int64", "description": "Unique identifier" }, "/candidateVolunteerExperience/organization": { "type": "string", "description": "Organization name" }, "/candidateVolunteerExperience/startDate": { "type": "string", "format": "date", "description": "Start date" }, "/candidateVolunteerExperience/startDateDay": { "type": "integer", "description": "Start date - day component" }, "/candidateVolunteerExperience/startDateMonth": { "type": "integer", "description": "Start date - month component" }, "/candidateVolunteerExperience/startDateYear": { "type": "integer", "description": "Start date - year component" }, "/candidateVolunteerExperience/endDate": { "type": "string", "format": "date", "description": "End date" }, "/candidateVolunteerExperience/endDateDay": { "type": "integer", "description": "End date - day component" }, "/candidateVolunteerExperience/endDateMonth": { "type": "integer", "description": "End date - month component" }, "/candidateVolunteerExperience/endDateYear": { "type": "integer", "description": "End date - year component" }, "/candidateVolunteerExperience/candidateId": { "type": "number", "description": "ID of the associated candidate.

To fetch the candidate, use Search candidates ↗." }, "/candidateVolunteerExperience/applicationId": { "type": "number", "description": "ID of the associated application.

To fetch the application, use Search applications ↗." } } }, "CandidateVolunteerExperienceSearchResponse": { "type": "object", "required": [ "items", "response_metadata" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateVolunteerExperienceSearchResponseObject" }, "description": "Array of candidate volunteer experience objects" }, "response_metadata": { "type": "object", "properties": { "next_cursor": { "type": [ "string", "null" ], "description": "Cursor for next page. Null if no more results." } } } } }, "ErrorResponse": { "type": "object", "required": [ "code", "message", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "INVALID_ARGUMENT", "FORBIDDEN", "RATE_LIMITED", "INTERNAL_ERROR", "NOT_FOUND" ], "description": "Error code identifying the type of error:\n- `INVALID_ARGUMENT`: Invalid request parameters\n- `FORBIDDEN`: Access denied (IP not allowed or feature disabled)\n- `RATE_LIMITED`: Too many requests\n- `INTERNAL_ERROR`: Server-side error\n- `NOT_FOUND`: Resource not found\n" }, "message": { "type": "string", "description": "Human-readable error message" }, "requestId": { "type": "string", "description": "Unique request identifier for tracking and debugging" } } } } } } ```