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.

Single Resource

Endpoints that return a single record wrap it in a data object: 

{
  "data": {
    "id": 123,
    "title": "Website Redesign",
    "created_at": "2023-01-01T12:00:00.000000Z",
    "updated_at": "2023-01-01T12:00:00.000000Z"
  }
}

Collections

List endpoints return an array under data alongside pagination links and meta: 

{
  "data": [
    { "id": 123, "title": "Website Redesign" },
    { "id": 124, "title": "Brand System" }
  ],
  "links": {
    "first": "https://go.outlign.co/api/v1/projects?page=1",
    "last": null,
    "prev": null,
    "next": "https://go.outlign.co/api/v1/projects?page=2"
  },
  "meta": {
    "current_page": 1,
    "current_page_url": "https://go.outlign.co/api/v1/projects?page=1",
    "from": 1,
    "path": "https://go.outlign.co/api/v1/projects",
    "per_page": 25,
    "to": 25
  }
}

Reading the examples: To keep things concise, the example responses on the endpoint pages show the contents of data (the object or array). Unless noted, single-resource responses are wrapped in { "data": { … } } and list responses in { "data": [ … ], "links": { … }, "meta": { … } } as shown above.

Error Response

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

Pagination

Most list endpoints are paginated. Use the page parameter to move between pages and per_page to control the page size (max 1000). Follow links.next from the response to fetch the next page — it is null on the last page. 

GET /api/v1/projects?per_page=25&page=2

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.