> ## 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. # Search locations — lightweight picker route. Search context: name. ## OpenAPI ````yaml https://api.offerclub.io/public-swagger-json post /v1.0/assets/locations/search 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/assets/locations/search: post: tags: - Public API — Assets summary: 'Search locations — lightweight picker route. Search context: name.' operationId: publicApiSearchLocations parameters: - 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 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchRequestDto' responses: '200': description: Matched locations content: application/json: schema: allOf: - $ref: '#/components/schemas/PaginationResponseDto' - properties: items: type: array items: $ref: '#/components/schemas/LocationSearchItemResponseDto' '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: SearchRequestDto: type: object properties: search: type: string description: Search string — matches on the resource-relevant fields excludeEntityIds: description: >- Entity IDs to exclude from results. Use in picker contexts to hide items the user has already linked elsewhere type: array items: type: string format: uuid 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 LocationSearchItemResponseDto: type: object properties: id: type: string description: The ID of the element name: type: string description: The internal name of the location title: type: string description: The public-facing headline of the location street: type: string description: The street name houseNumber: type: string description: The house number postalCode: type: string description: The postal code city: type: string description: The city country: type: string description: The country imageFileThumbnail: description: Resolved image thumbnail (signed URL + filename). allOf: - $ref: '#/components/schemas/FileImageThumbnailResponseDto' required: - id - name - title - street - houseNumber - postalCode - city - country - imageFileThumbnail 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 FileImageThumbnailResponseDto: type: object properties: thumbnailWidth: type: number nullable: true description: The width of the thumbnail thumbnailHeight: type: number nullable: true description: The height of the thumbnail thumbnailUrl: type: string nullable: true description: The (signed) URL for the thumbnail, null if the file is not an image thumbnailUrlExpiresAt: format: date-time type: string nullable: true description: >- The expiration date for the (signed) URL for the thumbnail, null if the file is not an image or the file is public accessible required: - thumbnailWidth - thumbnailHeight - thumbnailUrl - thumbnailUrlExpiresAt 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) ````