--- updatedAt: 2026-05-20T09:04:30.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 offers Searches offer 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": "Offers", "description": "Search and retrieve offers data" } ], "paths": { "/hiring/offers/search": { "post": { "tags": [ "Offers" ], "operationId": "post_hiring-offers-search", "summary": "Search offers", "description": "Searches offer 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/OfferSearchRequest" }, "examples": { "basicSearch": { "summary": "Basic search - all offers", "description": "Retrieve offer records with core fields", "value": { "fields": [ "/offer/id", "/offer/applicationId", "/offer/jobOpeningId", "/offer/candidateId", "/offer/status" ], "filters": [], "limit": 100 } }, "filteredSearch": { "summary": "Filter by application ID", "description": "Search with specific filter criteria", "value": { "fields": [ "/offer/id", "/offer/applicationId", "/offer/jobOpeningId", "/offer/candidateId", "/offer/status", "/offer/startDate", "/offer/salary", "/offer/createdAt" ], "filters": [ { "fieldId": "/offer/applicationId", "operator": "equals", "values": [ 7247348 ] } ], "limit": 50 } } } } } }, "responses": { "200": { "description": "Successfully retrieved offer 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/OfferSearchResponse" }, "examples": { "successResponse": { "summary": "Successful response", "value": { "items": [ { "/offer/id": 13001, "/offer/applicationId": 7247348, "/offer/jobOpeningId": 7247345, "/offer/candidateId": 7247347, "/offer/status": "approved", "/offer/startDate": "2024-10-01", "/offer/salary": { "value": 100000, "currency": "USD" }, "/offer/fieldConfig": [ { "fieldId": "salary", "isDisplayedInForm": true }, { "fieldId": "startDate", "isDisplayedInForm": true } ], "/offer/createdAt": "2024-08-20T16:00:00Z" } ], "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": [] }, { "Bearer": [] } ], "x-internal": false } } }, "components": { "securitySchemes": { "Basic": { "type": "http", "scheme": "basic", "description": "Basic HTTP authentication using service user credentials" }, "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "OAuth 2.0", "description": "OAuth 2.0 authentication using an Access Token is available for registered partners only. Try It! does not support the full HiBob OAuth flow. You can follow these steps to complete the OAuth 2.0 flow in Postman and then paste the token here." } }, "schemas": { "OfferSearchRequest": { "type": "object", "required": [ "fields" ], "default": { "fields": [ "/offer/id", "/offer/applicationId", "/offer/jobOpeningId", "/offer/candidateId", "/offer/status" ], "filters": [], "limit": 100 }, "properties": { "fields": { "type": "array", "items": { "type": "string", "enum": [ "/offer/id", "/offer/applicationId", "/offer/jobOpeningId", "/offer/candidateId", "/offer/status", "/offer/reason", "/offer/sentDateTime", "/offer/requestedBy", "/offer/eSignRequestId", "/offer/startDate", "/offer/approvalWorkflowExternalId", "/offer/salary", "/offer/createdAt", "/offer/fieldConfig", "/offer/eSignTemplateId", "/offer/eSignCompletedRequestFileId", "/offer/fileId", "/offer/comment" ] }, "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": [ "/offer/id", "/offer/applicationId", "/offer/jobOpeningId", "/offer/candidateId", "/offer/status" ], "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 } } }, "OfferSearchResponseObject": { "type": "object", "description": "Flat key-value map of field IDs to values. Only requested fields are included.", "properties": { "/offer/id": { "type": "integer", "format": "int64", "description": "Unique identifier" }, "/offer/applicationId": { "type": "number", "description": "ID of the associated application.

To fetch the application, use Search applications ↗." }, "/offer/jobOpeningId": { "type": "number", "description": "ID of the associated job opening.

To fetch the job opening, use Search job openings ↗." }, "/offer/candidateId": { "type": "number", "description": "ID of the associated candidate.

To fetch the candidate, use Search candidates ↗." }, "/offer/status": { "type": "string", "enum": [ "declined", "withdrawn", "negotiated", "accepted", "pending_candidate", "approved", "pending_approval", "expired" ], "description": "Offer status. Possible values:
" }, "/offer/reason": { "type": "string", "description": "Reason (e.g. for rejection or withdrawal)" }, "/offer/sentDateTime": { "type": "string", "format": "date-time", "description": "Timestamp when the offer was sent" }, "/offer/requestedBy": { "type": "string", "description": "Employee ID of the person who requested the offer

To read this employee, use Read company employee fields by employee ID ↗." }, "/offer/eSignRequestId": { "type": "string", "description": "E-signature request ID from the e-signature provider" }, "/offer/startDate": { "type": "string", "format": "date", "description": "Proposed start date" }, "/offer/approvalWorkflowExternalId": { "type": "string", "description": "External ID of the approval workflow instance associated with this offer. Use this to correlate with approval workflow data." }, "/offer/salary": { "type": "object", "description": "Salary details including amount and currency code.", "properties": { "value": { "type": "number", "description": "Salary amount (e.g. 100000)" }, "currency": { "type": "string", "description": "ISO 4217 currency code (e.g. \"USD\", \"EUR\", \"GBP\")" } } }, "/offer/createdAt": { "type": "string", "format": "date-time", "description": "Creation timestamp" }, "/offer/fieldConfig": { "type": "array", "description": "List of offer template fields and their display settings. Each item represents a merge field from the offer template.", "items": { "type": "object", "properties": { "fieldId": { "type": "string", "description": "Merge field identifier from the offer template" }, "isDisplayedInForm": { "type": "boolean", "description": "Whether this field is displayed in the offer form" } } } }, "/offer/eSignTemplateId": { "type": "string", "description": "E-signature template ID used to generate the signing request" }, "/offer/eSignCompletedRequestFileId": { "type": "string", "description": "File ID of the completed e-signature document" }, "/offer/fileId": { "type": "string", "description": "ID of the file attached to this offer" }, "/offer/comment": { "type": "string", "description": "Offer comment" } } }, "OfferSearchResponse": { "type": "object", "required": [ "items", "response_metadata" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OfferSearchResponseObject" }, "description": "Array of offer 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" } } } } } } ```