API Documentation

POST /api/v1/auth/login

Authenticate a user and receive an access token. The token should be included in the Authorization header for subsequent requests.

Request Parameters

Parameter	Type	Required	Description
email	string	Yes	User email address
password	string	Yes	User password

Example Request

curl

curl -X POST https://api.nexus.com/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "your_password"
  }'

Example Response

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "user": {
    "id": 123,
    "email": "user@example.com",
    "name": "John Doe"
  }
}

GET /api/v1/users

Retrieve a list of users. Supports pagination and filtering.

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number (default: 1)
limit	integer	No	Items per page (default: 20, max: 100)
search	string	No	Search by name or email

Example Request

JavaScript

const response = await fetch('https://api.nexus.com/v1/users?page=1&limit=20', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();

POST /api/v1/projects

Create a new project. Returns the created project object with a unique ID.

Example Request

Python

import requests

headers = {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
}

data = {
    'name': 'My Project',
    'description': 'Project description',
    'team_id': 123
}

response = requests.post(
    'https://api.nexus.com/v1/projects',
    headers=headers,
    json=data
)

print(response.json())

Request Parameters

Example Request

Example Response

Query Parameters

Example Request

Example Request

Need Help Getting Started?