Search

Type to search documentation...

API Endpoints

Complete reference of available Ajrly API endpoints for projects, users, and resources.

This page lists the primary API endpoints available in the Ajrly platform.

Projects

List Projects

GET /v1/projects

Returns a paginated list of projects for the authenticated user.

Query Parameters:

ParameterTypeDescription
pagenumberPage number
per_pagenumberItems per page
statusstringFilter: active, archived

Response:

{
  "data": [
    {
      "id": "proj_abc123",
      "name": "My Project",
      "status": "active",
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-02-01T14:00:00Z"
    }
  ],
  "meta": {
    "total": 5,
    "page": 1,
    "per_page": 20
  }
}

Create Project

POST /v1/projects

Request Body:

{
  "name": "New Project",
  "description": "Project description",
  "visibility": "private"
}

Response: 201 Created

Get Project

GET /v1/projects/:id

Update Project

PUT /v1/projects/:id

Delete Project

DELETE /v1/projects/:id

Returns 204 No Content on success.

Users

Get Current User

GET /v1/users/me

Returns the profile of the authenticated user.

Response:

{
  "data": {
    "id": "usr_xyz789",
    "email": "user@example.com",
    "name": "Jane Doe",
    "avatar_url": "https://cdn.ajrly.com/avatars/usr_xyz789.jpg",
    "created_at": "2025-06-01T08:00:00Z"
  }
}

Update Profile

PUT /v1/users/me

List Team Members

GET /v1/teams/:team_id/members

API Keys

List API Keys

GET /v1/api-keys

Create API Key

POST /v1/api-keys

Request Body:

{
  "name": "Production Key",
  "scopes": ["read", "write"],
  "expires_at": "2027-01-01T00:00:00Z"
}

Revoke API Key

DELETE /v1/api-keys/:id

Webhooks

List Webhooks

GET /v1/webhooks

Create Webhook

POST /v1/webhooks

See the Webhooks guide for detailed configuration.

Last updated: February 20, 2026 Edit this page on GitHub

Was this page helpful?