Outlign

Outlign API

v1.0 Documentation

Welcome to the Outlign API v1.0

The Outlign API provides programmatic access to your project management data. Build integrations, automate workflows, and sync data with other tools your team uses.

Quick Start

1

Authenticate

Set up OAuth2 authentication to access the API

2

Make your first request

Start with fetching your companies or projects

3

Build your integration

Use the documented endpoints to create your application

Base URL

https://go.outlign.co/api/v1

Response Format

All API responses return JSON. Successful requests return a 200 status code along with the requested data.

Standard Response

{
  "id": 123,
  "title": "Example Project",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:00:00Z"
}

Error Response

{
  "message": "The given data was invalid.",
  "errors": {
    "title": ["The title field is required."]
  }
}

Pagination

List endpoints use cursor-based pagination. Use the per_page parameter to control the number of results returned (max 1000). 

GET /api/v1/projects?per_page=25

Rate Limiting

API requests are rate limited to ensure fair usage. Current limits allow for reasonable integration usage patterns.

Note: Rate limiting headers are included in API responses to help you monitor your usage.

Next Steps

Learn how to authenticate with the Outlign API using OAuth2 and make your first request.