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

# Login

> **/auth/login**

<Note>
  This endpoint requires authentication. Include your Bearer token in the Authorization header.
</Note>

## Description

**/auth/login**

**Description:**\
The `/auth/login` endpoint authenticates a user and returns an access token.

**Rate Limiting:**\
This endpoint is rate limited to 20 requests per 3 minutes per IP address.

**Method:**\
`POST`

**Request Payload:**

| Parameter  | Type    | Description                            | Required |
| ---------- | ------- | -------------------------------------- | -------- |
| email      | string  | User's email address                   | Yes      |
| password   | string  | User's password                        | Yes      |
| rememberMe | boolean | Whether to extend the session duration | No       |

**Response:**\
Returns an access token and user information on successful authentication.

> **Note:** The access token should be included in the `Authorization` header as `Bearer <token>` for subsequent requests.

**Security:**\
This endpoint requires no authentication.

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('https://api.royalti.io/auth/login', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      "email": "sample-email",
      "password": "sample-password",
      "loginToken": "sample-loginToken"
    })
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
    'https://api.royalti.io/auth/login',
    headers={
      'Authorization': f'Bearer {token}'
    },
    json={"email":"sample-email","password":"sample-password","loginToken":"sample-loginToken"}
  )

  data = response.json()
  print(data)
  ```

  ```bash cURL theme={null}
  curl -X POST https://api.royalti.io/auth/login \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"email":"sample-email","password":"sample-password","loginToken":"sample-loginToken"}'

  ```
</CodeGroup>


## OpenAPI

````yaml post /auth/login
openapi: 3.0.0
info:
  title: Royalti.io API
  description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
  version: 2.6.0
  contact:
    name: Royalti.io Support
    email: support@royalti.io
    url: https://royalti.io
  license:
    name: Proprietary
    url: https://royalti.io/terms
servers:
  - url: https://api.royalti.io
    description: Production server
  - url: https://api-dev.royalti.io
    description: Development server
  - url: http://localhost:8084
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Accounting
    description: Accounting and financial transaction operations
  - name: DDEX
    description: DDEX operations (ERN/MEAD, messages, delivery, providers)
  - name: Label
    description: Label management operations
  - name: Internal Webhooks
    description: Internal system webhooks for royalty processing and downloads
  - name: Payment Webhooks
    description: Payment processor webhook endpoints
  - name: Billing Webhooks
    description: Stripe billing and subscription webhooks
  - name: Infrastructure Webhooks
    description: Cloudflare domain and SSL webhooks
  - name: Distribution Webhooks
    description: Digital distribution platform webhooks (FUGA)
paths:
  /auth/login:
    post:
      tags:
        - Auth
      summary: Login
      description: >-
        **/auth/login**


        **Description:**  

        The `/auth/login` endpoint authenticates a user and returns an access
        token.


        **Rate Limiting:**  

        This endpoint is rate limited to 20 requests per 3 minutes per IP
        address.


        **Method:**  

        `POST`


        **Request Payload:**


        | Parameter | Type | Description | Required |

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

        | email | string | User's email address | Yes |

        | password | string | User's password | Yes |

        | rememberMe | boolean | Whether to extend the session duration | No |


        **Response:**  

        Returns an access token and user information on successful
        authentication.


        > **Note:** The access token should be included in the `Authorization`
        header as `Bearer <token>` for subsequent requests.


        **Security:**  

        This endpoint requires no authentication.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
                  description: The email of the user
                password:
                  type: string
                  description: The password associated with the username
                loginToken:
                  type: string
                  description: loginToken allows user to signin without using password
              required:
                - email
            example:
              email: someone@example.com
              password: Testpassword
      responses:
        '200':
          description: Success With LoginLink
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  workspaces:
                    type: array
                    items:
                      type: object
                      properties:
                        workspaceId:
                          type: string
                        name:
                          type: string
                        status:
                          type: string
                        userType:
                          type: array
                          items:
                            type: array
                            items:
                              type: string
                        role:
                          type: string
                  refresh_token:
                    type: string
              example:
                message: Successful
                workspaces:
                  - workspaceId: 7bd60554-4f63-4c62-a5f6-c29c3f67cb2a
                    name: Royalti Demo
                    status: active
                    userType:
                      - - Artist
                    role: user
                refresh_token: >-
                  eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjRlNDI3MjllLWYxNGQtNDhlNy1iNGNiLWMxODliNmQxNThlNiIsIm5hbWUiOiJyZWZyZXNoX3Rva2VuIiwiaWF0IjoxNzA3MzAxNTAxLCJleHAiOjE3MDczODc5MDF9.TPEuW4Fuzycid1sGEeXGZseIK187QE5ECF92WDhcpHE
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Format: "Bearer
        {token}"

````