API Overview

The Ajrly REST API gives you programmatic access to all platform features. This page covers the conventions and patterns used across all endpoints.

Base URL

https://api.ajrly.com/v1

All endpoints are relative to this base URL.

Request Format

Headers

Every request should include:

Header	Value	Required
Authorization	Bearer <token>	Yes
Content-Type	application/json	For POST/PUT
Accept	application/json	Recommended
X-Request-Id	UUID for request tracing	Optional

Request Body

For POST and PUT requests, send JSON in the request body:

{
  "name": "My Project",
  "description": "A sample project",
  "visibility": "private"
}

Response Format

All responses follow a consistent structure:

Success Response

{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123"
  }
}

List Response

{
  "data": [ ... ],
  "meta": {
    "total": 42,
    "page": 1,
    "per_page": 20,
    "request_id": "req_abc123"
  }
}

Error Response

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "status": 404,
    "request_id": "req_abc123"
  }
}

Pagination

List endpoints support cursor-based pagination:

Parameter	Type	Default	Description
page	number	1	Page number
per_page	number	20	Items per page (max 100)

GET /v1/projects?page=2&per_page=50

Filtering

Most list endpoints support filtering:

GET /v1/projects?status=active&sort=created_at&order=desc

Common Filter Parameters

Parameter	Description
status	Filter by status
sort	Field to sort by
order	Sort direction (asc or desc)
search	Full-text search
created_after	Filter by creation date
created_before	Filter by creation date

HTTP Status Codes

Code	Meaning
200	Success
201	Created
204	No Content (successful delete)
400	Bad Request — invalid parameters
401	Unauthorized — invalid or missing credentials
403	Forbidden — insufficient permissions
404	Not Found
429	Too Many Requests — rate limit exceeded
500	Internal Server Error

Versioning

The API is versioned through the URL path. The current version is v1.

When breaking changes are introduced, a new version will be released. Previous versions remain supported for at least 12 months after deprecation.