Outlign

Outlign API

v1.0 Documentation

Task Assignees API

Manage who is assigned to a task (step). Assignees must be members of the project, and tasks in internal phases can only be assigned to agency team members.

The Assignee Object

{
  "id": 123,
  "name": "John Doe",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "avatar": "https://go.outlign.co/storage/avatars/123.jpg"
}

Attributes

Attribute Type Description
id integer The user's unique identifier
name string The user's full name
first_name string The user's first name
last_name string The user's last name
email string The user's email address
avatar string|null URL of the user's avatar, if set

List Assignees

Returns the users currently assigned to a task.

GET /api/v1/steps/{step}/assignees

Example Request

GET /api/v1/steps/123/assignees
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Example Response

[
  {
    "id": 123,
    "name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com",
    "avatar": "https://go.outlign.co/storage/avatars/123.jpg"
  }
]

Assign Users

Adds one or more users to a task. Existing assignees are kept — this endpoint only adds the users you provide. The full, updated assignee list is returned.

POST /api/v1/steps/{step}/assignees

Request Body

Parameter Type Required Description
user_ids integer[] Yes One or more user IDs to assign. Each must be an existing user.

Membership rules: All users must be members of the task's project. If the task is in an internal phase, only agency company members may be assigned. Violations return 422 Unprocessable Entity with a message listing the offending user IDs.

Example Request

POST /api/v1/steps/123/assignees
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
Accept: application/json

{
  "user_ids": [123, 456]
}

Example Response

201 Created

[
  { "id": 123, "name": "John Doe", "first_name": "John", "last_name": "Doe", "email": "john@example.com", "avatar": null },
  { "id": 456, "name": "Jane Roe", "first_name": "Jane", "last_name": "Roe", "email": "jane@example.com", "avatar": null }
]

Unassign a User

Removes a single user from a task.

DELETE /api/v1/steps/{step}/assignees/{user}

Example Request

DELETE /api/v1/steps/123/assignees/456
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Example Response

204 No Content