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",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:00:00Z"
}

Attributes

Attribute	Type	Description
id	integer	Unique identifier for the company
title	string	The company's name
created_at	string	ISO 8601 timestamp when the company was created
updated_at	string	ISO 8601 timestamp when the company was last updated

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",
    "created_at": "2023-01-01T12:00:00Z",
    "updated_at": "2023-01-01T12:00:00Z"
  },
  {
    "id": 457,
    "title": "Marketing Agency LLC",
    "created_at": "2023-01-15T09:30:00Z",
    "updated_at": "2023-01-15T09:30:00Z"
  }
]