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

# List projects



## OpenAPI

````yaml /openapi.yaml get /projects
openapi: 3.0.3
info:
  title: Leonar API
  description: >
    REST API for accessing and managing workspace data in Leonar CRM.


    ## Authentication


    All API requests require a Bearer token in the Authorization header:


    ```

    Authorization: Bearer leo_xxxxx

    ```


    API keys can be created and managed in Settings > API.


    ## Rate limiting


    - **2000 requests per hour by default**, configurable per workspace and
    shared by all API keys owned by the same user

    - Rate limit headers are included in all responses


    ## Pagination


    List endpoints support pagination via `limit` and `offset` query parameters.
  version: 1.0.0
  contact:
    name: Leonar Support
    url: https://leonar.ai
    email: support@leonar.ai
servers:
  - url: https://app.leonar.app/api/v1
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Contacts
    description: Manage contacts in your workspace
  - name: Companies
    description: Manage companies and their relationships
  - name: Deals
    description: Track and manage sales deals
  - name: Deal Pipelines
    description: View deal pipeline configurations
  - name: Projects
    description: Organize recruiting projects
  - name: Pipeline Entries
    description: Manage candidates in project pipelines
  - name: Tasks
    description: Track to-dos and follow-ups
  - name: Tags
    description: Organize resources with tags
  - name: Notes
    description: Manage notes on contacts, companies, deals, and projects
  - name: Sequences
    description: Automate outreach campaigns
  - name: Conversations
    description: View conversations across channels
  - name: Messages
    description: Send messages via email, LinkedIn, or WhatsApp
  - name: Enrichment
    description: Find emails and phone numbers for contacts
  - name: Sourcing
    description: Search and import candidates
  - name: Connected Accounts
    description: View linked LinkedIn accounts
paths:
  /projects:
    get:
      tags:
        - Projects
      summary: List projects
      operationId: list-projects
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/updatedAfter'
        - $ref: '#/components/parameters/updatedBefore'
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - archived
              - all
            default: active
        - name: owner_id
          in: query
          schema:
            type: string
            format: uuid
        - name: job_status
          in: query
          description: Filter projects by Job Posting lifecycle status.
          schema:
            type: string
            enum:
              - draft
              - published
              - closed
        - name: job_enabled
          in: query
          description: Filter projects by whether Job Posting is enabled.
          schema:
            type: boolean
        - name: job_visible_on_client_site
          in: query
          description: Filter projects by visibility on an external client jobsite.
          schema:
            type: boolean
        - name: search
          in: query
          schema:
            type: string
        - name: sort
          in: query
          schema:
            type: string
            default: '-created_at'
          description: 'Options: `created_at`, `updated_at`, `name`'
      responses:
        '200':
          description: List of projects
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Project'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
      description: Items per page
    offset:
      name: offset
      in: query
      schema:
        type: integer
        minimum: 0
        default: 0
      description: Items to skip
    updatedAfter:
      name: updated_after
      in: query
      schema:
        type: string
        format: date-time
      description: >-
        Return resources changed after this RFC 3339 timestamp. Contacts may
        redeliver rows exactly at the boundary; consumers must upsert
        idempotently.
    updatedBefore:
      name: updated_before
      in: query
      schema:
        type: string
        format: date-time
      description: >-
        Return resources with `updated_at` less than or equal to this RFC 3339
        timestamp.
  schemas:
    Project:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - active
            - archived
        client_name:
          type: string
          nullable: true
        client_company:
          type: string
          nullable: true
        location:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        job_enabled:
          type: boolean
        job_status:
          type: string
          enum:
            - draft
            - published
            - closed
          nullable: true
        job_slug:
          type: string
          nullable: true
        job_visible_on_client_site:
          type: boolean
        job_data:
          allOf:
            - $ref: '#/components/schemas/JobPostingData'
          nullable: true
        job_published_at:
          type: string
          format: date-time
          nullable: true
        job_closed_at:
          type: string
          format: date-time
          nullable: true
        job_views_count:
          type: integer
        job_applications_count:
          type: integer
        job_questions:
          type: array
          description: Ordered application questions configured for this Job Posting.
          items:
            $ref: '#/components/schemas/JobPostingQuestion'
        location_city:
          type: string
          nullable: true
        location_country:
          type: string
          nullable: true
        location_country_code:
          type: string
          nullable: true
        location_region:
          type: string
          nullable: true
        location_place_id:
          type: string
          nullable: true
        location_latitude:
          type: number
          format: double
          nullable: true
        location_longitude:
          type: number
          format: double
          nullable: true
        location_zip:
          type: string
          nullable: true
        template_id:
          type: string
          format: uuid
          nullable: true
        project_variables:
          allOf:
            - $ref: '#/components/schemas/ProjectVariables'
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        owners:
          type: array
          items:
            type: object
            properties:
              user_id:
                type: string
                format: uuid
              first_name:
                type: string
              last_name:
                type: string
              email:
                type: string
        entries_count:
          type: integer
        pipeline:
          type: object
          description: Present on project detail responses.
          properties:
            stages:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  name:
                    type: string
                  position:
                    type: integer
                  system_category:
                    type: string
                    nullable: true
                    description: >-
                      System category for the stage, for example `sourced`,
                      `contacted`, or `rejected`.
                  color:
                    type: string
                    nullable: true
                  entries_count:
                    type: integer
      example:
        id: d4e5f6a7-8901-23bc-defa-456789012cde
        name: Senior Frontend Engineers - Paris
        status: active
        client_name: Jean Dupont
        client_company: Doctolib
        location: Paris, France
        description: Hiring 3 senior frontend engineers for the patient portal team
        job_enabled: true
        job_status: published
        job_slug: senior-frontend-engineers-paris
        job_visible_on_client_site: true
        job_data:
          job_title: Senior Frontend Engineer
          language: en
          location_type: hybrid
          contract_type: cdi
          description: <p>Join the patient portal team.</p>
          require_cv: true
        job_published_at: '2025-01-22T09:00:00Z'
        job_closed_at: null
        job_views_count: 325
        job_applications_count: 18
        job_questions:
          - id: f7b8c9d0-1234-45ef-abcd-789012345ef1
            project_id: d4e5f6a7-8901-23bc-defa-456789012cde
            question_text: Why do you want to join?
            question_type: long_text
            is_required: true
            position: 0
        location_city: Paris
        location_country: France
        location_country_code: FR
        template_id: null
        created_at: '2025-01-20T09:00:00Z'
        updated_at: '2025-02-10T14:00:00Z'
        owners:
          - user_id: f6a7b8c9-0123-45de-fabc-678901234ef0
            first_name: Alice
            last_name: Recruiter
            email: alice@leonar.ai
        entries_count: 42
        pipeline:
          stages:
            - id: e5f6a7b8-9012-34cd-efab-567890123def
              name: Sourced
              position: 0
              system_category: sourced
              color: '#3b82f6'
              entries_count: 12
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Total number of results matching the query
        limit:
          type: integer
          description: Maximum items per page
        offset:
          type: integer
          description: Number of items skipped
        has_more:
          type: boolean
          description: Whether more pages are available
      example:
        total: 142
        limit: 50
        offset: 0
        has_more: true
    JobPostingData:
      type: object
      description: Complete Job Posting content configured on the project.
      properties:
        job_title:
          type: string
        language:
          type: string
          enum:
            - fr
            - en
        category_id:
          type: string
          format: uuid
        location_type:
          type: string
          enum:
            - on_site
            - remote
            - hybrid
        remote_policy:
          type: string
        contract_type:
          type: string
          enum:
            - cdi
            - cdd
            - freelance
            - internship
            - apprenticeship
            - interim
            - other
        work_time:
          type: string
          enum:
            - full_time
            - part_time
        seniority_level:
          type: string
          enum:
            - non_executive
            - supervisor
            - executive
        start_date:
          type: string
          format: date
        end_date:
          type: string
          format: date
        salary_min:
          type: number
          minimum: 0
        salary_max:
          type: number
          minimum: 0
        salary_period:
          type: string
          enum:
            - yearly
            - monthly
            - daily
            - hourly
        salary_currency:
          type: string
          minLength: 3
          maxLength: 3
        salary_visible:
          type: boolean
        experience_years_min:
          type: number
          minimum: 0
          maximum: 50
        experience_years_max:
          type: number
          minimum: 0
          maximum: 50
        education_level:
          type: string
          enum:
            - none
            - vocational
            - high_school
            - bachelor
            - master_plus
        required_skills:
          type: array
          items:
            type: string
        nice_to_have_skills:
          type: array
          items:
            type: string
        description:
          type: string
          description: Rich-text HTML.
        responsibilities:
          type: string
          description: Rich-text HTML.
        requirements:
          type: string
          description: Rich-text HTML.
        benefits:
          type: string
          description: Rich-text HTML.
        require_cv:
          type: boolean
        require_cover_letter:
          type: boolean
        ask_location:
          type: boolean
        ask_salary:
          type: boolean
        application_email:
          type: string
          format: email
        welcome_kit:
          $ref: '#/components/schemas/JobPostingWelcomeKitSettings'
    JobPostingQuestion:
      type: object
      properties:
        id:
          type: string
          format: uuid
        project_id:
          type: string
          format: uuid
        question_text:
          type: string
        question_type:
          type: string
          enum:
            - short_text
            - long_text
            - single_choice
            - multiple_choice
            - date
            - yes_no
            - number
            - location
        options:
          type: array
          nullable: true
          items:
            type: object
            properties:
              value:
                type: string
              label:
                type: string
        is_required:
          type: boolean
        position:
          type: integer
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    ProjectVariables:
      type: object
      additionalProperties: false
      description: >-
        Project-scoped sequence variables shared by all pipeline entries in the
        project.
      properties:
        project_variable_1:
          type: string
          maxLength: 2000
          nullable: true
        project_variable_2:
          type: string
          maxLength: 2000
          nullable: true
        project_variable_3:
          type: string
          maxLength: 2000
          nullable: true
        project_variable_4:
          type: string
          maxLength: 2000
          nullable: true
        project_variable_5:
          type: string
          maxLength: 2000
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_api_key
                - insufficient_scope
                - rate_limit_exceeded
                - validation_error
                - not_found
                - internal_error
                - billing_required
                - plan_upgrade_required
              description: >
                Error codes:

                - `invalid_api_key` — API key is missing, malformed, or revoked

                - `insufficient_scope` — API key lacks the required scope for
                this endpoint

                - `rate_limit_exceeded` — Too many requests (2000/hour)

                - `validation_error` — Request body or parameters failed
                validation

                - `not_found` — The requested resource does not exist

                - `internal_error` — Unexpected server error

                - `billing_required` — Workspace has no active subscription

                - `plan_upgrade_required` — Current plan does not include this
                feature
            message:
              type: string
              description: Human-readable error description
    JobPostingWelcomeKitSettings:
      type: object
      properties:
        contract_type:
          type: string
          enum:
            - FULL_TIME
            - PART_TIME
            - TEMPORARY
            - FREELANCE
            - INTERNSHIP
            - APPRENTICESHIP
        language:
          type: string
          enum:
            - fr
            - en
        remote:
          type: string
          enum:
            - fulltime
            - partial
            - punctual
            - 'no'
        cms_sites_references:
          type: string
        office_id:
          type: integer
  responses:
    Unauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_api_key
              message: Invalid API key
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key starting with `leo_`

````