Outlign

Outlign API

v1.0 Documentation

Companies API

Access companies that the authenticated user belongs to. Companies are the top-level organizational units that contain clients, projects, and team members.

The Company Object

{
  "id": 456,
  "title": "Design Studio Inc"
}

Attributes

Attribute Type Description
id integer Unique identifier for the company
title string The company's name

List Companies

Retrieves a list of companies that the authenticated user has access to.

GET /api/v1/companies

Example Request

GET /api/v1/companies
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Example Response

[
  { "id": 456, "title": "Design Studio Inc" },
  { "id": 457, "title": "Marketing Agency LLC" }
]

Get a Company

Retrieves a specific company by ID. Returns 404 Not Found if you are not a member of it.

GET /api/v1/companies/{id}

Example Request

GET /api/v1/companies/456
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Example Response

{ "id": 456, "title": "Design Studio Inc" }

Read-only: Companies cannot be created, updated, or deleted through the API. They are managed inside Outlign.