Loomstack
Browse all docs
API Reference

API Authentication and Getting Started

5 min read

API Authentication and Getting Started

Loomstack provides a REST API for building custom integrations and automations. This guide covers authentication and basic usage.

Getting Started

Prerequisites

  • Loomstack Pro or Enterprise plan
  • API access enabled (contact sales@loomstack.com)
  • Your workspace ID
  • An API key

Generating an API Key

  1. Go to Settings > API & Integrations > API Keys

  2. Click + Generate Key

  3. Name your key (e.g., “Mobile App Integration”)

  4. Select permissions:

    • read:projects - Read project data
    • read:tasks - Read task data
    • write:tasks - Create and update tasks
    • read:users - Read team member information
    • write:users - Manage team members
    • read:reports - Access reporting data

  5. Click Create

  6. Copy and save your key securely (you won’t see it again)

API Key Security

  • Store keys in environment variables, not in code
  • Rotate keys every 90 days
  • Revoke keys for deleted applications
  • Use minimal required permissions
  • Never commit keys to version control

Authentication

Include your API key in all requests:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.loomstack.com/v1/projects

Base URL

All API endpoints use:

https://api.loomstack.com/v1

HTTP Methods

  • GET - Retrieve data
  • POST - Create new resources
  • PUT - Update existing resources
  • DELETE - Remove resources
  • PATCH - Partial updates

Response Format

All responses are JSON:

{
  "success": true,
  "data": {
    "id": "proj_123",
    "name": "Website Redesign",
    "description": "Q1 2024 redesign project"
  }
}

Rate Limiting

  • Standard rate limit: 1000 requests per minute
  • Pro rate limit: 5000 requests per minute
  • Enterprise: Custom limits available

Responses include rate limit headers:

X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1234567890

Error Handling

Error responses include status codes and messages:

{
  "success": false,
  "error": {
    "code": "INVALID_PROJECT_ID",
    "message": "Project not found"
  }
}

Common status codes:

  • 200 - Success
  • 201 - Created
  • 400 - Bad request
  • 401 - Unauthorized (invalid API key)
  • 404 - Not found
  • 429 - Rate limit exceeded
  • 500 - Server error

Next Steps

Support

Having issues with API authentication?

Was this helpful?