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

# Login

> ### **Login API Documentation**

#### **API Overview**

- **Name:** Login API
    
- **Description:** This API endpoint allows users to log in by providing their credentials (username/email and password).
    
- **Method:** `POST`
    
- **Endpoint URL:** `/v1/login`
    

### **Authentication**

- No authentication is required to access this endpoint, as this is the login process.
    

### **Request**

#### **HTTP Method:**

- `POST`
    

#### **URL:**

- `/v1/login`
    

#### **Headers:**

| Header Name | Description | Required | Example |
| --- | --- | --- | --- |
| `Content-Type` | The content type of the request | Yes | `application/json` |
| `Accept` | Expected response format | No | `application/json` |

#### **Request Body:**

The request body should be sent in JSON format with the following parameters:

| Field Name | Data Type | Description | Required | Example |
| --- | --- | --- | --- | --- |
| `email` | `string` | The email of the user | Yes | `"user@example.com"` |
| `password` | `string` | The password of the user | Yes | `"yourpassword123"` |

### **Responses**

#### **Success Response:**

- **Status Code:** `200 OK`
    
- **Message:** `Success`
    
- **Data:** `User object`



## OpenAPI

````yaml post /v1/login
openapi: 3.0.0
info:
  title: Pauls Job Public Endpoints
  description: >-
    #### **Description:**


    This API provides a comprehensive suite of endpoints for managing user
    authentication, session control, and other key functionalities within the
    application for Pauls Job. The endpoints are designed to ensure secure and
    efficient communication between clients and the server, offering robust
    access control mechanisms through token-based authentication.


    #### **Key Features:**


    - **Authentication:** Allows users to securely log in using their
    credentials and receive a token for accessing protected resources.
        
    - **Session Management:** Provides a logout mechanism to securely end user
    sessions and invalidate tokens.
        
    - **Error Handling:** Clear and descriptive error messages ensure that
    issues such as invalid credentials, expired tokens, or missing parameters
    are easily identifiable.
        

    This API is built with a focus on security and ease of use, making it
    essential for integrating user authentication and session management into
    applications while maintaining a high standard of data protection.
  version: 1.0.0
servers:
  - url: https://api.hyrd.de
security: []
tags:
  - name: Users
    description: >-
      #### **Description:**


      The folder contains the foundational information and essential API
      endpoints for starting with the authentication and session management of
      the application. This includes the critical login and logout
      functionalities, which are necessary for users to authenticate and manage
      their sessions securely.


      #### **APIs Included:**


      1. **Login API**: Allows users to log in by providing their credentials
      and receive an authentication token.
          
      2. **Logout API**: Enables users to log out by invalidating the token and
      ending their session.
          

      These endpoints are designed to facilitate secure access control and
      session handling, making them an essential starting point for any
      interaction with the platform's protected resources.
  - name: General
  - name: Company
  - name: Company > Candidate
  - name: Company > Api Integrations
paths:
  /v1/login:
    post:
      tags:
        - Users
      summary: Login
      description: >-
        ### **Login API Documentation**


        #### **API Overview**


        - **Name:** Login API
            
        - **Description:** This API endpoint allows users to log in by providing
        their credentials (username/email and password).
            
        - **Method:** `POST`
            
        - **Endpoint URL:** `/v1/login`
            

        ### **Authentication**


        - No authentication is required to access this endpoint, as this is the
        login process.
            

        ### **Request**


        #### **HTTP Method:**


        - `POST`
            

        #### **URL:**


        - `/v1/login`
            

        #### **Headers:**


        | Header Name | Description | Required | Example |

        | --- | --- | --- | --- |

        | `Content-Type` | The content type of the request | Yes |
        `application/json` |

        | `Accept` | Expected response format | No | `application/json` |


        #### **Request Body:**


        The request body should be sent in JSON format with the following
        parameters:


        | Field Name | Data Type | Description | Required | Example |

        | --- | --- | --- | --- | --- |

        | `email` | `string` | The email of the user | Yes |
        `"user@example.com"` |

        | `password` | `string` | The password of the user | Yes |
        `"yourpassword123"` |


        ### **Responses**


        #### **Success Response:**


        - **Status Code:** `200 OK`
            
        - **Message:** `Success`
            
        - **Data:** `User object`
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                user:
                  login: john.doe@yopmail.com
                  password: yourpassword123
      responses:
        '401':
          description: Unauthorized
          headers:
            Date:
              schema:
                type: string
                example: Wed, 27 Mar 2024 12:01:06 GMT
            Content-Type:
              schema:
                type: string
                example: application/json; charset=utf-8
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Connection:
              schema:
                type: string
                example: keep-alive
            Cache-Control:
              schema:
                type: string
                example: no-cache
            X-Request-Id:
              schema:
                type: string
                example: aedccec59e1d82941db9f4c38f8a4cf9
            X-Runtime:
              schema:
                type: number
                example: '0.050598'
            vary:
              schema:
                type: string
                example: Origin
            Strict-Transport-Security:
              schema:
                type: string
                example: max-age=15724800; includeSubDomains
          content:
            application/json:
              schema:
                type: object
              example:
                error: Invalid Login or password.

````