> ## Documentation Index > Fetch the complete documentation index at: https://docs.offerclub.io/llms.txt > Use this file to discover all available pages before exploring further. # List offers (filterable by status / search / archived). ## OpenAPI ````yaml https://api.offerclub.io/public-swagger-json get /v1.0/offers openapi: 3.0.0 info: title: Offerclub.io Public API description: >- External API for integrations. Authenticate every request with the `x-api-key` header. version: '1.0' contact: {} license: name: Legal Terms url: https://offerclub.io/legal/terms servers: - url: https://api.offerclub.io security: [] tags: [] paths: /v1.0/offers: get: tags: - Public API — Offers summary: List offers (filterable by status / search / archived). operationId: publicApiListOffers parameters: - name: status required: false in: query description: Filter by offer status. Omit to receive offers in every status. schema: $ref: '#/components/schemas/OfferStatus' - name: search required: false in: query description: The search query for the offer schema: type: string - name: isArchived required: false in: query description: Whether to filter for archived offers or not. Defaults to false. schema: default: false type: boolean - name: limit required: false in: query description: The maximum amount of retrieved items per page schema: minimum: 1 maximum: 20 default: 20 type: number - name: page required: false in: query description: The page number to retrieve items from. schema: minimum: 1 default: 1 type: number responses: '200': description: Offers retrieved successfully content: application/json: schema: allOf: - $ref: '#/components/schemas/PaginationResponseDto' - properties: items: type: array items: $ref: '#/components/schemas/OfferItemResponseDto' '400': description: '`VALIDATION_ERROR` — Validation error' content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorResponseDto' - type: object properties: details: oneOf: - $ref: >- #/components/schemas/ValidationErrorDetailsResponseDto '401': description: '`UNAUTHORIZED` — Unauthorized — missing or invalid API key' content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' '403': description: >- `ONBOARDING_USER_NEEDS_REGISTRATION` — User bound to the API key no longer exists `ONBOARDING_USER_NEEDS_ORGANIZATION` — The user behind the API key no longer belongs to any organization `ORGANIZATION_NOT_FOUND` — Organization bound to the API key no longer exists content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' '500': description: '`INTERNAL_ERROR` — An unexpected error occurred' content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' security: - ApiKey: [] components: schemas: OfferStatus: type: string enum: - DRAFT - SENT - WON - LOST PaginationResponseDto: type: object properties: items: description: The retrieved items type: array items: type: string limit: type: number description: The maximum amount of retrieved items per page page: type: number description: The page number totalCount: type: number description: The total number of items required: - items - limit - page - totalCount OfferItemResponseDto: type: object properties: id: type: string description: The ID of the element createdAt: format: date-time type: string description: The created at date of the element publicId: type: string description: Short URL-safe identifier used in the public share link offerNumber: type: string nullable: true description: User-set business reference number status: enum: - DRAFT - SENT - WON - LOST type: string description: Current offer status title: type: string nullable: true description: Offer title shown to the client price: type: number nullable: true description: Total offer price in the smallest currency unit (cents) validUntil: format: date-time type: string nullable: true description: Date until which the offer is valid clientFirstName: type: string nullable: true description: Client first name clientLastName: type: string nullable: true description: Client last name clientCompanyName: type: string nullable: true description: Client company name availableActions: description: >- Server-computed map of dashboard actions the caller may currently perform on this offer allOf: - $ref: '#/components/schemas/OfferAvailableActionsResponseDto' required: - id - createdAt - publicId - offerNumber - status - title - price - validUntil - clientFirstName - clientLastName - clientCompanyName - availableActions ErrorResponseDto: type: object properties: statusCode: type: number description: HTTP status code example: 400 code: enum: - INTERNAL_ERROR - VALIDATION_ERROR - ONBOARDING_USER_NEEDS_REGISTRATION - ONBOARDING_USER_NEEDS_ORGANIZATION - ORGANIZATION_NOT_FOUND - UNAUTHORIZED - FILE_NOT_FOUND - FILE_TYPE_NOT_ALLOWED - FILE_TYPE_NOT_ALLOWED_FOR_CONTEXT - FILE_ALREADY_COMMITTED - FILE_UPLOAD_FAILED - OFFER_OFFER_NUMBER_TAKEN - OFFER_INVALID_TRANSITION - OFFER_NOT_SENDABLE - OFFER_PAYMENT_PLAN_INVALID - OFFER_PAYMENT_PLAN_VALIDATION_FAILED - OFFER_ASSETS_VALIDATION_FAILED - ENTITY_NOT_FOUND type: string description: Machine-readable error code example: VALIDATION_ERROR message: type: string description: Human-readable error message example: Validation failed details: type: object additionalProperties: true nullable: true description: Additional error details (e.g. validation errors, missing fields) example: errors: - email must be a string required: - statusCode - code - message ValidationErrorDetailsResponseDto: type: object properties: errors: description: The validation errors type: array items: $ref: '#/components/schemas/FlatValidationErrorDetailsResponseDto' required: - errors OfferAvailableActionsResponseDto: type: object properties: canUpdate: type: boolean description: Whether the offer can currently be updated via PATCH canDelete: type: boolean description: Whether the offer can currently be deleted canSend: type: boolean description: Whether the offer can currently be sent (via EMAIL or LINK_ONLY) canMarkWon: type: boolean description: Whether the offer can currently be manually marked as won canMarkLost: type: boolean description: Whether the offer can currently be manually marked as lost canArchive: type: boolean description: Whether the offer can currently be archived canUnarchive: type: boolean description: Whether the offer can currently be unarchived canManagePaymentPlans: type: boolean description: >- Whether payment plans can currently be added/removed (DRAFT + price >= 100 + not archived) canManageAssets: type: boolean description: Whether offer assets can currently be managed. required: - canUpdate - canDelete - canSend - canMarkWon - canMarkLost - canArchive - canUnarchive - canManagePaymentPlans - canManageAssets FlatValidationErrorDetailsResponseDto: type: object properties: field: type: string description: The field that failed validation message: type: string description: The message that explains the validation failure required: - field - message securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: API key for authentication (can be generated in the settings) ````