> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bindbee.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Offers

> Returns a list of Offer objects.



## OpenAPI

````yaml get /api/ats/v1/offers
openapi: 3.1.0
info:
  title: Bindbee APIs
  version: 0.1.0
servers:
  - url: https://api.bindbee.dev
  - url: https://api-eu.bindbee.dev
security: []
paths:
  /api/ats/v1/offers:
    get:
      tags:
        - Offer
      summary: Get Offers
      description: Returns a list of Offer objects.
      operationId: get_offers_api_ats_v1_offers_get
      parameters:
        - name: ids
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: The ID of the offers to fetch
            examples:
              - >-
                01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a
            title: Ids
          description: The ID of the offers to fetch
        - name: remote_id
          in: query
          required: false
          schema:
            type: string
            description: The third-party API ID of the matching object.
            examples:
              - '3235005483341316245'
            title: Remote Id
          description: The third-party API ID of the matching object.
        - name: application
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: The application id of the offer
            examples:
              - 0194bcb7-bf3e-7315-8628-0dc9bf1b6d92
            title: Application
          description: The application id of the offer
        - name: creator
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: The creator for the offers to fetch
            examples:
              - >-
                01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a
            title: Creator
          description: The creator for the offers to fetch
        - name: include_raw_data
          in: query
          required: false
          schema:
            type: boolean
            description: Include raw data in the response
            examples:
              - false
            default: false
            title: Include Raw Data
          description: Include raw data in the response
        - name: include_custom_fields
          in: query
          required: false
          schema:
            type: boolean
            description: Whether to include custom fields in the response.
            examples:
              - false
            default: false
            title: Include Custom Fields
          description: Whether to include custom fields in the response.
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            description: Number of results to return per page. Maximum size is 200.
            default: 50
            title: Page Size
          description: Number of results to return per page. Maximum size is 200.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            description: The pagination cursor value.
            title: Cursor
          description: The pagination cursor value.
        - name: modified_after
          in: query
          required: false
          schema:
            type: string
            description: >-
              If provided, only objects synced by Bindbee after this date time
              will be returned. Format: DateTime (ISO 8601)
            examples:
              - '2024-02-21T21:22:12.993Z'
            title: Modified After
          description: >-
            If provided, only objects synced by Bindbee after this date time
            will be returned. Format: DateTime (ISO 8601)
        - name: expand
          in: query
          required: false
          schema:
            type: string
            description: >-
              Which relations should be returned in expanded form. Multiple
              relation names should be comma separated without spaces. You can
              also specify required fields in [] for each relation name.
            examples:
              - manager[first_name,last_name]
            title: Expand
          description: >-
            Which relations should be returned in expanded form. Multiple
            relation names should be comma separated without spaces. You can
            also specify required fields in [] for each relation name.
        - name: x-connector-token
          in: header
          required: true
          schema:
            type: string
            title: X-Connector-Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_AtsOffer_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    PaginatedResponse_AtsOffer_:
      properties:
        cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Cursor
          description: Cursor value to fetch next set of items
          examples:
            - MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1
        page_size:
          type: integer
          title: Page Size
          description: Indicates the count of items in the response
          examples:
            - 50
        items:
          items:
            $ref: '#/components/schemas/AtsOffer'
          type: array
          title: Items
          description: List of items in the current response
          examples:
            - {}
      type: object
      required:
        - cursor
        - page_size
        - items
      title: PaginatedResponse[AtsOffer]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AtsOffer:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          examples:
            - 018b18ef-c487-703c-afd9-0ca478ccd9d6
        remote_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Remote Id
          description: The third-party API ID of the matching object.
          examples:
            - '123321'
        modified_at:
          type: string
          title: Modified At
          description: This is the datetime that this object was last updated by Bindbee
          examples:
            - '2021-10-16T00:00:00Z'
        raw_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Raw Data
          description: This is the Raw data
          examples:
            - key_1: Platform dependent data 1
              key_2: Platform dependent data 2
        custom_fields:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Custom Fields
          description: The custom fields related to the model
          examples:
            - category_group: REG
              disability_type: ASBERG
              hire_date: '1991-03-16T00:00:00'
              hire_source: REFER
              nationality: USA
              original_hire_date: '1991-03-16T00:00:00'
        application:
          anyOf:
            - {}
            - type: 'null'
          title: Application
          description: The identifier of the application to which the offer is related.
          examples:
            - 018b4bfb-5ece-70b1-ad5e-862a9433aa65
        creator:
          anyOf:
            - {}
            - type: 'null'
          title: Creator
          description: The identifier of the user who created the offer.
          examples:
            - 018b4bfb-5ece-70b1-ad5e-862a9433aa65
        remote_created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Remote Created At
          description: >-
            The ISO date string when the offer was created in the third-party
            system.
          examples:
            - '2021-01-01T00:00:00Z'
        closed_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Closed At
          description: The ISO date string when the offer was closed.
          examples:
            - '2021-01-01T00:00:00Z'
        sent_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Sent At
          description: The ISO date string when the offer was sent to the candidate.
          examples:
            - '2021-01-01T00:00:00Z'
        start_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Start Date
          description: The proposed start date for the candidate, as an ISO date string.
          examples:
            - '2021-01-01T00:00:00Z'
        status:
          anyOf:
            - type: string
            - type: 'null'
          enum:
            - DRAFT
            - APPROVAL-SENT
            - APPROVED
            - SENT
            - SENT-MANUALLY
            - OPENED
            - DENIED
            - SIGNED
            - DEPRECATED
          title: Status
          description: >-
            The current status of the offer. If the value is not one of the
            defined enum values, the original value passed through will be
            returned.
          examples:
            - APPROVED
      type: object
      required:
        - id
        - remote_id
        - modified_at
        - custom_fields
        - application
        - creator
        - remote_created_at
        - closed_at
        - sent_at
        - start_date
        - status
      title: AtsOffer
      description: >-
        The AtsOffer object represents a job offer associated with an
        application within the ATS.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````