Lytho Logo
API docs by Redocly

Lytho Workflow API (v1)

Download OpenAPI specification:Download

RESTful endpoints used to interact with Lytho Workflow.

WorkRequest

Gets an array of comments for a work request by id

Retrieves the comments for a specific work request by its unique identifier. This includes information such as the comment text, author, and timestamp.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Work Request.

query Parameters
format
required
string
Default: 1
Value: "HTML"

1 (HTML)

page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
Array of objects (Comment)

The list of items on the current page.

page
integer <int32>

The current page number (1-based).

PagingSize (integer)

The number of items returned per page.

totalItemCount
integer <int32>

The total number of items across all pages.

totalPageCount
integer <int32>

The total number of pages based on TotalItemCount and PageSize.

Response samples

Content type
application/json
{
}

Gets an array of deliverable file URLs for a work request by id

Deliverable files are the final output files that are generated as a result of completing a work request. This endpoint retrieves the URLs for these deliverable files associated with a specific work request, identified by its unique identifier. Use this endpoint to access the final output files of a work request without needing to access the individual review versions.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Work Request.

Responses

Response Schema: application/json
Array
fileVersionName
string

The display name of the file version.

fileId
integer <int32>

The unique identifier of the file.

fileVersionId
integer <int32>

The unique identifier of the specific file version.

url
string

The pre-signed URL for downloading the file.

urlExpiration
string <date-time>

The date and time at which the pre-signed URL expires.

assetId
integer or null <int32>

The identifier of the proof asset associated with this file, if applicable.

Response samples

Content type
application/json
[
]

Gets a work request by id

Retrieves the details of a specific work request by its unique identifier. This includes information such as the work request's current status, associated tasks, and metadata. Use this endpoint to view the overall information of a work request.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Work Request.

Responses

Response Schema: application/json
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

name
string [ 0 .. 255 ] characters

The name of the work request.

status
string or null

The current status of the work request.

messageToRequester
string or null

A message from the assignee back to the person who submitted the request.

autoNumber
integer or null <int32>

The auto-generated sequential number for this work request within the account.

archived
boolean

Whether the work request has been archived.

dueDate
string or null <date-time>

The current due date of the work request.

originalDueDate
string or null <date-time>

The original due date before any modifications.

dueDateNotified
string or null <date-time>

The date and time when the due date notification was sent.

submittedDate
string or null <date-time>

The date and time when the work request was submitted.

approvedDate
string or null <date-time>

The date and time when the work request was approved.

completedDate
string or null <date-time>

The date and time when the work request was completed.

declinedDateTime
string or null <date-time>

The date and time when the work request was declined.

declinedMessage
string or null

The reason provided when the work request was declined.

requesterUserId
integer <int32>

The unique identifier of the user who submitted the work request.

requesterFullName
string or null

The full name of the user who submitted the work request.

requesterEmail
string or null

The email address of the user who submitted the work request. Matches the SubmittedByUser search filter.

approvedByUserFullName
string or null

The full name of the user who approved the work request.

completedByUserFullName
string or null

The full name of the user who completed the work request.

declinedByUserFullName
string or null

The full name of the user who declined the work request.

commentListId
integer or null <int32>

The identifier of the comment list associated with this work request.

formTemplateId
integer or null <int32>

The unique identifier of the form template used to create this work request, if any.

formTemplateName
string or null

The name of the form template used to create this work request, if any.

Array of objects (Tag)

The tags applied to this work request.

createdDateTime
string <date-time>

The date and time the work request was created.

Response samples

Content type
application/json
{
}

Patches a Work Request using the provided values

Updates one or more fields of a work request using JSON Patch operations. The fields supported by the work request's patch validator are Name and Archived. This endpoint allows for partial updates to a work request without needing to send the entire work request object.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Work Request.

Request Body schema: application/json-patch+json
required

Test and Replace are required

string

Responses

Response Schema: application/json
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

name
string [ 0 .. 255 ] characters

The name of the work request.

status
string or null

The current status of the work request.

messageToRequester
string or null

A message from the assignee back to the person who submitted the request.

autoNumber
integer or null <int32>

The auto-generated sequential number for this work request within the account.

archived
boolean

Whether the work request has been archived.

dueDate
string or null <date-time>

The current due date of the work request.

originalDueDate
string or null <date-time>

The original due date before any modifications.

dueDateNotified
string or null <date-time>

The date and time when the due date notification was sent.

submittedDate
string or null <date-time>

The date and time when the work request was submitted.

approvedDate
string or null <date-time>

The date and time when the work request was approved.

completedDate
string or null <date-time>

The date and time when the work request was completed.

declinedDateTime
string or null <date-time>

The date and time when the work request was declined.

declinedMessage
string or null

The reason provided when the work request was declined.

requesterUserId
integer <int32>

The unique identifier of the user who submitted the work request.

requesterFullName
string or null

The full name of the user who submitted the work request.

requesterEmail
string or null

The email address of the user who submitted the work request. Matches the SubmittedByUser search filter.

approvedByUserFullName
string or null

The full name of the user who approved the work request.

completedByUserFullName
string or null

The full name of the user who completed the work request.

declinedByUserFullName
string or null

The full name of the user who declined the work request.

commentListId
integer or null <int32>

The identifier of the comment list associated with this work request.

formTemplateId
integer or null <int32>

The unique identifier of the form template used to create this work request, if any.

formTemplateName
string or null

The name of the form template used to create this work request, if any.

Array of objects (Tag)

The tags applied to this work request.

createdDateTime
string <date-time>

The date and time the work request was created.

Request samples

Content type
application/json-patch+json
Example
[
]

Response samples

Content type
application/json
{
}

Gets the form fields for a single work request

Use this to get the request form fields and values, including any attachments with file URLs.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the work request.

Responses

Response Schema: application/json
workRequestId
integer <int32>

The identifier of the work request these form fields belong to.

requestName
string or null

The name of the work request.

submittedDate
string or null <date-time>

The date and time the work request was submitted.

templateId
integer or null <int32>

The identifier of the request form template used to create this work request.

templateName
string or null

The name of the request form template used to create this work request.

Array of objects (WorkRequestAttachment)

The list of files attached to the work request.

Array of objects (WorkRequestFormField)

The list of form fields and their submitted values.

Response samples

Content type
application/json
{
}

Gets the reporting metrics for a work request

Returns the aggregate and time metrics computed for a work request, matching the equivalent in-app Report values. These are batch-refreshed, not real-time. If the work request exists but its metrics have not yet been computed, metric fields are returned as null.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the work request.

Responses

Response Schema: application/json
id
integer <int32>

The id of the work request.

requestDuration
integer or null <int32>

Total elapsed duration of the work request.

commentCount
integer or null <int32>

Number of comments on the work request.

fileCount
integer or null <int32>

Number of files attached to the work request.

totalTimeTracked
integer or null <int32>

Total time tracked against the work request.

timeFromRequestToApproval
integer or null <int32>

Time elapsed from request to approval.

timeFromApprovalToProofSent
integer or null <int32>

Time elapsed from approval to the proof being sent.

levelOfEffort
integer or null <int32>

Level of effort recorded for the work request.

timeTrackedPercent
number or null <decimal>

Percentage of the work request's duration that had time tracked against it.

Response samples

Content type
application/json
{
}

Gets a paged list of work request information

This endpoint supports paging only and does not support additional filtering by status, submitter, or other work request fields. For more granular querying of work requests, use the search endpoint.

Authorizations:
Lytho Workflow Auth
query Parameters
ids
required
Array of integers <int32> [ items <int32 > ]
Example: ids=0
page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

name
string [ 0 .. 255 ] characters

The name of the work request.

status
string or null

The current status of the work request.

messageToRequester
string or null

A message from the assignee back to the person who submitted the request.

autoNumber
integer or null <int32>

The auto-generated sequential number for this work request within the account.

archived
boolean

Whether the work request has been archived.

dueDate
string or null <date-time>

The current due date of the work request.

originalDueDate
string or null <date-time>

The original due date before any modifications.

dueDateNotified
string or null <date-time>

The date and time when the due date notification was sent.

submittedDate
string or null <date-time>

The date and time when the work request was submitted.

approvedDate
string or null <date-time>

The date and time when the work request was approved.

completedDate
string or null <date-time>

The date and time when the work request was completed.

declinedDateTime
string or null <date-time>

The date and time when the work request was declined.

declinedMessage
string or null

The reason provided when the work request was declined.

requesterUserId
integer <int32>

The unique identifier of the user who submitted the work request.

requesterFullName
string or null

The full name of the user who submitted the work request.

requesterEmail
string or null

The email address of the user who submitted the work request. Matches the SubmittedByUser search filter.

approvedByUserFullName
string or null

The full name of the user who approved the work request.

completedByUserFullName
string or null

The full name of the user who completed the work request.

declinedByUserFullName
string or null

The full name of the user who declined the work request.

commentListId
integer or null <int32>

The identifier of the comment list associated with this work request.

formTemplateId
integer or null <int32>

The unique identifier of the form template used to create this work request, if any.

formTemplateName
string or null

The name of the form template used to create this work request, if any.

Array of objects (Tag)

The tags applied to this work request.

createdDateTime
string <date-time>

The date and time the work request was created.

Response samples

Content type
application/json
{
}

Gets the form fields for a list of work requests

Use this to get a list of request form fields and values, including any attachments with file URLs.

Authorizations:
Lytho Workflow Auth
query Parameters
ids
required
Array of integers <int32> [ items <int32 > ]
Example: ids=0

The ids of the work requests.

page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
Array
workRequestId
integer <int32>

The identifier of the work request these form fields belong to.

requestName
string or null

The name of the work request.

submittedDate
string or null <date-time>

The date and time the work request was submitted.

templateId
integer or null <int32>

The identifier of the request form template used to create this work request.

templateName
string or null

The name of the request form template used to create this work request.

Array of objects (WorkRequestAttachment)

The list of files attached to the work request.

Array of objects (WorkRequestFormField)

The list of form fields and their submitted values.

Response samples

Content type
application/json
[
]

Gets an array of users for a work request by id

Retrieves the list of users assigned to a specific work request by its unique identifier.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Work Request.

Responses

Response Schema: application/json
Array
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32>

The unique identifier of the entity.

firstName
string [ 0 .. 30 ] characters

The user's first name.

lastName
string [ 0 .. 30 ] characters

The user's last name.

email
string [ 0 .. 255 ] characters

The user's email address.

UserStatusType (integer)

The user's current status within the account.

Response samples

Content type
application/json
[
]

Searches work requests based on provided criteria.

Use this endpoint to perform a search for work requests using various criteria such as name, status, submitter, submission date range, and custom fields. This allows for more granular filtering of work requests compared to the basic paged list endpoint.

Authorizations:
Lytho Workflow Auth
query Parameters
name
string or null

Filters work requests by name.

isArchived
required
boolean
Default: false

Filters work requests based on their archived status.

status
string or null

Filters work requests by their current status.

submittedByUser
string or null

Filters work requests by the user who submitted them. Use email address.

submittedDateFrom
string or null <date-time>

Filters work requests submitted on or after this date.

submittedDateTo
string or null <date-time>

Filters work requests submitted on or before this date.

customFieldName
string or null

The name of a custom field to filter by.

customFieldValue
string or null

The value of the custom field to filter by. Must be used in conjunction with CustomFieldName.

tagIds
Array of integers or null <int32>

Filters work requests by tag IDs. AND/OR behavior is controlled by OperatorMode.

operatorMode
required
integer
Default: 1
Enum: 1 2

Defines how multiple criteria should be combined (e.g., AND, OR).

Responses

Response Schema: application/json
ids
Array of integers <int32> [ items <int32 > ]

The list of entity identifiers that match the search criteria.

totalCount
integer <int32>

The total number of matching entities.

Response samples

Content type
application/json
{
}

Task

Gets Workflow comments on a task

Gets comments from the comment thread on the Workflow Task.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Task.

query Parameters
format
required
string
Default: 1
Value: "HTML"

1 (HTML)

page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
Array of objects (Comment)

The list of items on the current page.

page
integer <int32>

The current page number (1-based).

PagingSize (integer)

The number of items returned per page.

totalItemCount
integer <int32>

The total number of items across all pages.

totalPageCount
integer <int32>

The total number of pages based on TotalItemCount and PageSize.

Response samples

Content type
application/json
{
}

Gets the description of a task

Gets the rich text description for a task by its unique identifier. Use the format parameter to control whether the output is returned as HTML or plain text.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Task.

query Parameters
format
string or null
Default: "HTML"
Value: "HTML"

The output format of the description.

Responses

Response Schema: application/json
id
integer <int32>

The unique identifier of the entity.

description
string or null

The description content in the requested format (HTML, Markdown, or plain text).

Response samples

Content type
application/json
{
}

Gets a task by id

Retrieves the details of a specific task by its unique identifier. This includes information such as the task's current status, associated proof, and metadata.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Task.

Responses

Response Schema: application/json
name
string [ 0 .. 255 ] characters

The name of the task.

archived
boolean

Whether the task has been archived.

description
string or null

The description of the task. Returns HTML by default; use the /description endpoint to request plain text or Markdown.

startDate
string or null <date-time>

The date and time the task is scheduled to start.

dueDate
string or null <date-time>

The due date of the task.

completedDate
string or null <date-time>

The date and time the task was completed.

commentListId
integer or null <int32>

The identifier of the comment list associated with this task.

status
string or null

The current status of the task.

levelOfEffort
integer or null <int32>

The estimated level of effort for the task, in hours.

projectUID
integer or null <int32>

The identifier of the project this task belongs to.

Array of objects (Tag)

The tags applied to this task.

createdDateTime
string <date-time>

The date and time the task was created.

accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

Response samples

Content type
application/json
{
}

Patches a Task using the provided values

Updates one or more fields of a task using JSON Patch operations. The fields supported by the task's patch validator are Name, StartDate, DueDate, and Archived. This endpoint allows for partial updates to a task without needing to send the entire task object. Date Values need to be set to UTC Timezone.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Task.

Request Body schema: application/json-patch+json
required

Test and Replace are required

string

Responses

Response Schema: application/json
name
string [ 0 .. 255 ] characters

The name of the task.

archived
boolean

Whether the task has been archived.

description
string or null

The description of the task. Returns HTML by default; use the /description endpoint to request plain text or Markdown.

startDate
string or null <date-time>

The date and time the task is scheduled to start.

dueDate
string or null <date-time>

The due date of the task.

completedDate
string or null <date-time>

The date and time the task was completed.

commentListId
integer or null <int32>

The identifier of the comment list associated with this task.

status
string or null

The current status of the task.

levelOfEffort
integer or null <int32>

The estimated level of effort for the task, in hours.

projectUID
integer or null <int32>

The identifier of the project this task belongs to.

Array of objects (Tag)

The tags applied to this task.

createdDateTime
string <date-time>

The date and time the task was created.

accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

Request samples

Content type
application/json-patch+json
Example
[
]

Response samples

Content type
application/json
{
}

Gets signed file URLs for a task

Retrieves signed URLs for accessing the files attached to a task. These URLs are valid for a limited time and provide secure access to the requested files.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Task.

Responses

Response Schema: application/json
Array
fileVersionName
string

The display name of the file version.

fileId
integer <int32>

The unique identifier of the file.

fileVersionId
integer <int32>

The unique identifier of the specific file version.

url
string

The pre-signed URL for downloading the file.

urlExpiration
string <date-time>

The date and time at which the pre-signed URL expires.

assetId
integer or null <int32>

The identifier of the proof asset associated with this file, if applicable.

Response samples

Content type
application/json
[
]

Gets the reporting metrics for a task

Returns the aggregate and time metrics computed for a task, matching the equivalent in-app Report values. These are batch-refreshed, not real-time. If the task exists but its metrics have not yet been computed, metric fields are returned as null.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the task.

Responses

Response Schema: application/json
id
integer <int32>

The id of the task.

taskDuration
integer or null <int32>

Total elapsed duration of the task.

commentCount
integer or null <int32>

Number of comments on the task.

fileCount
integer or null <int32>

Number of files attached to the task.

timeTracked
integer or null <int32>

Total time tracked against the task.

timeInToDo
integer or null <int32>

Time the task spent in a To Do status.

timeInInProgress
integer or null <int32>

Time the task spent in an In Progress status.

timeFromRequestToApproval
integer or null <int32>

Time elapsed from request to approval for the task.

timeTrackedPercent
number or null <decimal>

Percentage of the task's duration that had time tracked against it.

Response samples

Content type
application/json
{
}

Gets paginated descriptions for tasks by ids

Gets paginated rich text descriptions for multiple tasks by their unique identifiers. Use the format parameter to control whether descriptions are returned as HTML or plain text.

Authorizations:
Lytho Workflow Auth
query Parameters
format
string or null
Default: "HTML"
Value: "HTML"

The format for RTE description (e.g. HTML)

ids
required
Array of integers <int32> [ items <int32 > ]
Example: ids=0

A list of ids

page
required
integer <int32>
Default: 1

The page number to fetch

pageSize
required
integer
Default: 10
Enum: 10 20 30

The number of items per page

Responses

Response Schema: application/json
Array of objects (GetEntityDescriptionLookupResult)

The list of items on the current page.

page
integer <int32>

The current page number (1-based).

PagingSize (integer)

The number of items returned per page.

totalItemCount
integer <int32>

The total number of items across all pages.

totalPageCount
integer <int32>

The total number of pages based on TotalItemCount and PageSize.

Response samples

Content type
application/json
{
}

Gets a paged list of tasks from an array of task ids

Retrieves the details of multiple tasks by their unique identifiers. This endpoint supports paging only and does not support additional filtering by status or other task fields. For more granular querying of tasks, use the search endpoint.

Authorizations:
Lytho Workflow Auth
query Parameters
ids
required
Array of integers <int32> [ items <int32 > ]
Example: ids=0
page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
name
string [ 0 .. 255 ] characters

The name of the task.

archived
boolean

Whether the task has been archived.

description
string or null

The description of the task. Returns HTML by default; use the /description endpoint to request plain text or Markdown.

startDate
string or null <date-time>

The date and time the task is scheduled to start.

dueDate
string or null <date-time>

The due date of the task.

completedDate
string or null <date-time>

The date and time the task was completed.

commentListId
integer or null <int32>

The identifier of the comment list associated with this task.

status
string or null

The current status of the task.

levelOfEffort
integer or null <int32>

The estimated level of effort for the task, in hours.

projectUID
integer or null <int32>

The identifier of the project this task belongs to.

Array of objects (Tag)

The tags applied to this task.

createdDateTime
string <date-time>

The date and time the task was created.

accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

Response samples

Content type
application/json
{
}

Gets users associated with a task

Retrieves the list of users who are assigned to a specific task.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Task.

Responses

Response Schema: application/json
Array
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32>

The unique identifier of the entity.

firstName
string [ 0 .. 30 ] characters

The user's first name.

lastName
string [ 0 .. 30 ] characters

The user's last name.

email
string [ 0 .. 255 ] characters

The user's email address.

UserStatusType (integer)

The user's current status within the account.

Response samples

Content type
application/json
[
]

Search for tasks in a workflow

Searches for tasks within a workflow based on specified criteria. Allows filtering by name, status, archive status, parent project, and date ranges. Results reflect the current state of each task.

Authorizations:
Lytho Workflow Auth
query Parameters
name
string or null

Filters tasks by name.

isArchived
required
boolean
Default: false

Filters tasks based on their archived status.

projectId
integer or null <int32>

Filters tasks by their parent project ID.

status
string or null

Filters tasks by their current status.

createdDateFrom
string or null <date-time>

Filters tasks created on or after this date.

createdDateTo
string or null <date-time>

Filters tasks created on or before this date.

completedDateFrom
string or null <date-time>

Filters tasks completed on or after this date.

completedDateTo
string or null <date-time>

Filters tasks completed on or before this date.

tagIds
Array of integers or null <int32>

Filters tasks by tag IDs. AND/OR behavior is controlled by OperatorMode.

operatorMode
required
integer
Default: 1
Enum: 1 2

Defines how multiple criteria should be combined (e.g., AND, OR).

Responses

Response Schema: application/json
ids
Array of integers <int32> [ items <int32 > ]

The list of entity identifiers that match the search criteria.

totalCount
integer <int32>

The total number of matching entities.

Response samples

Content type
application/json
{
}

Reviews

Gets signed asset URLs for a proof version

Retrieves signed URLs for accessing the assets attached to a specific proof review version. These URLs are valid for a limited time and provide secure access to the requested files. The id parameter comes from the review version of a proof.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The review id (reviewId).

Responses

Response Schema: application/json
Array
fileVersionName
string

The display name of the file version.

fileId
integer <int32>

The unique identifier of the file.

fileVersionId
integer <int32>

The unique identifier of the specific file version.

url
string

The pre-signed URL for downloading the file.

urlExpiration
string <date-time>

The date and time at which the pre-signed URL expires.

assetId
integer or null <int32>

The identifier of the proof asset associated with this file, if applicable.

Response samples

Content type
application/json
[
]

Gets review annotation comments from a review.

Use this to get a list of comments for a specific proof review version, grouped by asset. Optionally, you can provide an assetId to get comments for a specific asset within the review (the asset must belong to the proof). This is useful for fetching all comments related to a review or filtering comments for a specific asset. The id parameter comes from the review version of a proof.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The review id (reviewId).

query Parameters
assetId
integer or null <int32>

Optional. When provided, returns comments only for that asset (must belong to the proof).

Responses

Response Schema: application/json
Array
assetId
integer <int32>
Array of objects (ReviewComment)

Response samples

Content type
application/json
[
]

Gets the active route for a review

Returns the active (published) route for the given review (proof version), including tiers, groups, and reviewer statuses.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the proof (ProofUID).

Responses

Response Schema: application/json
id
integer <int32>
proofId
integer <int32>
status
string
isComplete
boolean
templateId
integer or null <int32>
templateName
string or null
Array of objects (RouteTierDetail)

Response samples

Content type
application/json
{
}

Gets all review versions for a proof

Use this to get a list of all review versions for a specific proof, including details such as version number, creation date, and status. This is useful for tracking the history of reviews associated with a proof and understanding the progression of feedback over time. The id parameter comes from the proof itself, not the individual review versions.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the proof.

Responses

Response Schema: application/json
Array
reviewId
integer <int32>

The identifier of the proof this version belongs to.

versionNumber
integer or null <int32>

The version number of this review cycle.

status
string or null

The current status of this review version.

sentDate
string or null <date-time>

The date and time this review version was sent out.

endDate
string or null <date-time>

The date and time this review version ended.

Response samples

Content type
application/json
[
]

Accounts

Gets a proof route template

Returns the proof route template with the given id, including tiers and groups.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the proof route template.

Responses

Response Schema: application/json
id
integer <int32>
name
string
Array of objects (TemplateTierDetail)

Response samples

Content type
application/json
{
}

Gets all proof route templates

Returns the id and name of all proof route templates for the account.

Authorizations:
Lytho Workflow Auth

Responses

Response Schema: application/json
Array
id
integer <int32>

The unique identifier of the entity.

name
string

Response samples

Content type
application/json
[
]

Gets all account custom fields

Returns all active custom fields defined for the account. Use this endpoint to populate field selection lists. Select fields include their allowed values in the 'allowedValues' property.

Authorizations:
Lytho Workflow Auth

Responses

Response Schema: application/json
Array
id
integer <int32>

The unique identifier of the entity.

name
string

The display name of the custom field.

fieldType
string

The data type of the field. One of: Textbox, Select, Number, Date.

Array of objects (AccountCustomFieldChoice)

The selectable values for Select field types. Empty for non-enumerated types.

Response samples

Content type
application/json
[
]

Gets all account custom statuses

Returns all active custom statuses defined for the account. Use this endpoint to populate status selection lists. The 'type' field identifies the work item type the status applies to.

Authorizations:
Lytho Workflow Auth

Responses

Response Schema: application/json
Array
id
integer <int32>

The unique identifier of the entity.

name
string

The display name of the custom status.

type
integer <int32>

The work item type identifier indicating which work item type this status applies to (sourced from WorkItemStatusType.WorkItemTypeId).

color
string or null

The display color of the custom status, if set.

Response samples

Content type
application/json
[
]

Gets all form templates for the account

Returns all active (non-archived) form templates for the account, including the request type each template creates. Use this to look up templates by name or id, then cross-reference a work request's FormTemplateId to find all requests from that template.

Authorizations:
Lytho Workflow Auth

Responses

Response Schema: application/json
Array
id
integer <int32>

The unique identifier of the entity.

accountId
integer <int32>

The identifier of the account that owns this template.

formId
integer <int32>

The identifier of the form associated with this template.

name
string

The name of the form template.

description
string or null

The description of the form template.

formRequestType
string

The type of work request this template creates.

Response samples

Content type
application/json
[
]

Gets all project templates for the account

Returns all project templates defined for the account. Use this endpoint to discover which templates are available when creating projects, or to look up the template that generated a project via a project's WorkRequestUID.

Authorizations:
Lytho Workflow Auth

Responses

Response Schema: application/json
Array
id
integer <int32>

The unique identifier of the entity.

name
string

The name of the project template.

Response samples

Content type
application/json
[
]

Gets all account tags

Returns all active tags defined for the account. Use this endpoint to populate tag selection lists for work item filtering and search.

Authorizations:
Lytho Workflow Auth

Responses

Response Schema: application/json
Array
id
integer <int32>

The unique identifier of the entity.

name
string

The display name of the tag.

Response samples

Content type
application/json
[
]

Proof

Gets signed asset URLs for latest proof version

Assets returned are all the files added to the latest version of the proof. If you want assets from a specific version, use the Get Reviews Assets endpoint instead.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Proof.

Responses

Response Schema: application/json
Array
fileVersionName
string

The display name of the file version.

fileId
integer <int32>

The unique identifier of the file.

fileVersionId
integer <int32>

The unique identifier of the specific file version.

url
string

The pre-signed URL for downloading the file.

urlExpiration
string <date-time>

The date and time at which the pre-signed URL expires.

assetId
integer or null <int32>

The identifier of the proof asset associated with this file, if applicable.

Response samples

Content type
application/json
[
]

Gets Workflow comments on a proof

Gets comments from the comment thread on the Workflow Proof-Task. If you want comments on a proof review use the Get Review Comments endpoint instead.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Proof.

query Parameters
format
required
string
Default: 1
Value: "HTML"

1 (HTML)

page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
Array of objects (Comment)

The list of items on the current page.

page
integer <int32>

The current page number (1-based).

PagingSize (integer)

The number of items returned per page.

totalItemCount
integer <int32>

The total number of items across all pages.

totalPageCount
integer <int32>

The total number of pages based on TotalItemCount and PageSize.

Response samples

Content type
application/json
{
}

Gets the description of a proof

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Proof.

query Parameters
format
string or null
Default: "HTML"
Value: "HTML"

The output format of the description.

Responses

Response Schema: application/json
id
integer <int32>

The unique identifier of the entity.

description
string or null

The description content in the requested format (HTML, Markdown, or plain text).

Response samples

Content type
application/json
{
}

Gets a proof by id

Retrieves the details of a specific proof by its unique identifier. This includes information such as the proof's current status, associated tasks, and metadata. Use this endpoint to view the overall information of a proof without needing to access its individual review versions

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Proof.

Responses

Response Schema: application/json
name
string [ 0 .. 255 ] characters

The name of the task.

archived
boolean

Whether the task has been archived.

description
string or null

The description of the task. Returns HTML by default; use the /description endpoint to request plain text or Markdown.

startDate
string or null <date-time>

The date and time the task is scheduled to start.

dueDate
string or null <date-time>

The due date of the task.

completedDate
string or null <date-time>

The date and time the task was completed.

commentListId
integer or null <int32>

The identifier of the comment list associated with this task.

status
string or null

The current status of the task.

levelOfEffort
integer or null <int32>

The estimated level of effort for the task, in hours.

projectUID
integer or null <int32>

The identifier of the project this task belongs to.

Array of objects (Tag)

The tags applied to this task.

createdDateTime
string <date-time>

The date and time the task was created.

accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

versionNumber
integer or null <int32>

The version number of the proof. Each new review cycle increments this number.

sentDate
string or null <date-time>

The date and time the proof was sent out for review.

canceledDate
string or null <date-time>

The date and time the proof was canceled.

endDate
string or null <date-time>

The date and time the proof review period ended.

statusDate
string or null <date-time>

The date and time the proof status last changed.

Response samples

Content type
application/json
{
}

Patches a Proof using the provided values

Updates one or more fields of a proof using JSON Patch operations. The fields supported by the proof's patch validator are Name, StartDate, DueDate, and Archived. This endpoint allows for partial updates to a proof without needing to send the entire proof object. Date Values need to be set to UTC Timezone.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Proof.

Request Body schema: application/json-patch+json
required

Test and Replace are required

string

Responses

Response Schema: application/json
name
string [ 0 .. 255 ] characters

The name of the task.

archived
boolean

Whether the task has been archived.

description
string or null

The description of the task. Returns HTML by default; use the /description endpoint to request plain text or Markdown.

startDate
string or null <date-time>

The date and time the task is scheduled to start.

dueDate
string or null <date-time>

The due date of the task.

completedDate
string or null <date-time>

The date and time the task was completed.

commentListId
integer or null <int32>

The identifier of the comment list associated with this task.

status
string or null

The current status of the task.

levelOfEffort
integer or null <int32>

The estimated level of effort for the task, in hours.

projectUID
integer or null <int32>

The identifier of the project this task belongs to.

Array of objects (Tag)

The tags applied to this task.

createdDateTime
string <date-time>

The date and time the task was created.

accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

versionNumber
integer or null <int32>

The version number of the proof. Each new review cycle increments this number.

sentDate
string or null <date-time>

The date and time the proof was sent out for review.

canceledDate
string or null <date-time>

The date and time the proof was canceled.

endDate
string or null <date-time>

The date and time the proof review period ended.

statusDate
string or null <date-time>

The date and time the proof status last changed.

Request samples

Content type
application/json-patch+json
Example
[
]

Response samples

Content type
application/json
{
}

Gets signed file URLs for a proof

Retrieves signed URLs for accessing the files associated with a proof. These URLs are valid for a limited time and provide secure access to the requested files. These are the files (not review assets) that are attached to the proof-task and live across verisons.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Proof.

Responses

Response Schema: application/json
Array
fileVersionName
string

The display name of the file version.

fileId
integer <int32>

The unique identifier of the file.

fileVersionId
integer <int32>

The unique identifier of the specific file version.

url
string

The pre-signed URL for downloading the file.

urlExpiration
string <date-time>

The date and time at which the pre-signed URL expires.

assetId
integer or null <int32>

The identifier of the proof asset associated with this file, if applicable.

Response samples

Content type
application/json
[
]

Gets the reporting metrics for a proof

Returns the aggregate and time metrics computed for a proof, matching the equivalent in-app Report values. These are batch-refreshed, not real-time. If the task exists but its proof metrics have not yet been computed, metric fields are returned as null.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the task the proof belongs to.

Responses

Response Schema: application/json
id
integer <int32>

The id of the task the proof belongs to.

proofDuration
integer or null <int32>

Total elapsed duration of the proof.

currentVersionDuration
integer or null <int32>

Duration of the current version of the proof.

reviewDuration
integer or null <int32>

Total review duration of the proof.

timeTracked
integer or null <int32>

Total time tracked against the proof.

timeFromRequestToApproval
integer or null <int32>

Time elapsed from request to approval.

timeInToDo
integer or null <int32>

Time the proof spent in a To Do status.

timeInInProgress
integer or null <int32>

Time the proof spent in an In Progress status.

timeInInReview
integer or null <int32>

Time the proof spent in an In Review status.

timeInReturned
integer or null <int32>

Time the proof spent in a Returned status.

timeFromApprovalToProofSent
integer or null <int32>

Time elapsed from approval to the proof being sent.

timeTrackedPercent
number or null <decimal>

Percentage of the proof's duration that had time tracked against it.

Response samples

Content type
application/json
{
}

Gets the active route for a proof

Returns the active (published) route for the given proof, including tiers, groups, and reviewer statuses.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the proof (TaskUID).

Responses

Response Schema: application/json
id
integer <int32>
proofId
integer <int32>
status
string
isComplete
boolean
templateId
integer or null <int32>
templateName
string or null
Array of objects (RouteTierDetail)

Response samples

Content type
application/json
{
}

Gets paginated descriptions for Proofs by ids

Authorizations:
Lytho Workflow Auth
query Parameters
format
string or null
Default: "HTML"
Value: "HTML"

The format for RTE description (e.g. HTML)

ids
required
Array of integers <int32> [ items <int32 > ]
Example: ids=0

A list of ids

page
required
integer <int32>
Default: 1

The page number to fetch

pageSize
required
integer
Default: 10
Enum: 10 20 30

The number of items per page

Responses

Response Schema: application/json
Array of objects (GetEntityDescriptionLookupResult)

The list of items on the current page.

page
integer <int32>

The current page number (1-based).

PagingSize (integer)

The number of items returned per page.

totalItemCount
integer <int32>

The total number of items across all pages.

totalPageCount
integer <int32>

The total number of pages based on TotalItemCount and PageSize.

Response samples

Content type
application/json
{
}

Gets proofs for an from an array of proof ids

Retrieves the details of multiple proofs by their unique identifiers. This includes information such as each proof's current status, associated tasks, and metadata. Use this endpoint to view the overall information of multiple proofs without needing to access their individual versions. This is useful for batch retrieval of proof information when you have multiple proof ids to query.

Authorizations:
Lytho Workflow Auth
query Parameters
ids
required
Array of integers <int32> [ items <int32 > ]
Example: ids=0
page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
name
string [ 0 .. 255 ] characters

The name of the task.

archived
boolean

Whether the task has been archived.

description
string or null

The description of the task. Returns HTML by default; use the /description endpoint to request plain text or Markdown.

startDate
string or null <date-time>

The date and time the task is scheduled to start.

dueDate
string or null <date-time>

The due date of the task.

completedDate
string or null <date-time>

The date and time the task was completed.

commentListId
integer or null <int32>

The identifier of the comment list associated with this task.

status
string or null

The current status of the task.

levelOfEffort
integer or null <int32>

The estimated level of effort for the task, in hours.

projectUID
integer or null <int32>

The identifier of the project this task belongs to.

Array of objects (Tag)

The tags applied to this task.

createdDateTime
string <date-time>

The date and time the task was created.

accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

versionNumber
integer or null <int32>

The version number of the proof. Each new review cycle increments this number.

sentDate
string or null <date-time>

The date and time the proof was sent out for review.

canceledDate
string or null <date-time>

The date and time the proof was canceled.

endDate
string or null <date-time>

The date and time the proof review period ended.

statusDate
string or null <date-time>

The date and time the proof status last changed.

Response samples

Content type
application/json
{
}

Gets users associated with a proof

Retrieves the list of users who are associated with a specific proof. These do not include reviewers, only Team Members assigned to the work.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Proof.

Responses

Response Schema: application/json
Array
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32>

The unique identifier of the entity.

firstName
string [ 0 .. 30 ] characters

The user's first name.

lastName
string [ 0 .. 30 ] characters

The user's last name.

email
string [ 0 .. 255 ] characters

The user's email address.

UserStatusType (integer)

The user's current status within the account.

Response samples

Content type
application/json
[
]

Search for proofs in a workflow

Searches for proofs within a workflow based on specified criteria. This endpoint allows you to filter proofs by various attributes such as name, status, archive status, parent project, and date ranges. It will return results based on the latest version of each proof.

Authorizations:
Lytho Workflow Auth
query Parameters
name
string or null
status
string or null
isArchived
required
boolean
Default: false
projectId
integer or null <int32>

Filters proofs by their parent project ID.

createdDateFrom
string or null <date-time>

Filters proofs created on or after this date.

createdDateTo
string or null <date-time>

Filters proofs created on or before this date.

completedDateFrom
string or null <date-time>

Filters proofs completed on or after this date.

completedDateTo
string or null <date-time>

Filters proofs completed on or before this date.

tagIds
Array of integers or null <int32>

Filters proofs by tag IDs. AND/OR behavior is controlled by OperatorMode.

operatorMode
required
integer
Default: 1
Enum: 1 2

1 (Or), 2 (And)

Responses

Response Schema: application/json
ids
Array of integers <int32> [ items <int32 > ]

The list of entity identifiers that match the search criteria.

totalCount
integer <int32>

The total number of matching entities.

Response samples

Content type
application/json
{
}

Project

Gets Workflow comments on a project

Gets comments from the comment thread on the Workflow Project. These are project-level comments, not comments on individual tasks within the project.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Project.

query Parameters
format
required
string
Default: 1
Value: "HTML"

1 (HTML)

page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
Array of objects (Comment)

The list of items on the current page.

page
integer <int32>

The current page number (1-based).

PagingSize (integer)

The number of items returned per page.

totalItemCount
integer <int32>

The total number of items across all pages.

totalPageCount
integer <int32>

The total number of pages based on TotalItemCount and PageSize.

Response samples

Content type
application/json
{
}

Gets the description of a project

Gets the rich text description for a project by its unique identifier. Use the format parameter to control whether the output is returned as HTML or plain text.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Project.

query Parameters
format
string or null
Default: "HTML"
Value: "HTML"

The output format of the description.

Responses

Response Schema: application/json
id
integer <int32>

The unique identifier of the entity.

description
string or null

The description content in the requested format (HTML, Markdown, or plain text).

Response samples

Content type
application/json
{
}

Gets a project by id

Retrieves the details of a specific project by its unique identifier. This includes information such as the project's current status, associated tasks, and metadata.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Project.

Responses

Response Schema: application/json
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

name
string [ 0 .. 255 ] characters

The name of the project.

status
string or null

The current status of the project.

description
string or null

The description of the project. Returns HTML by default; use the /description endpoint to request plain text or Markdown.

archived
boolean

Whether the project has been archived.

startDate
string or null <date-time>

The date the project is scheduled to start.

dueDate
string or null <date-time>

The due date of the project.

completedDate
string or null <date-time>

The date and time the project was completed.

commentListId
integer or null <int32>

The identifier of the comment list associated with this project.

Array of objects (ProjectCustomField)

The list of custom fields and their values for this project.

Array of objects (Tag)

The tags applied to this project.

workRequestUID
integer or null <int32>

The unique identifier of the work request that generated this project, if any.

createdDateTime
string <date-time>

The date and time the project was created.

Response samples

Content type
application/json
{
}

Patches a Project using the provided values

Updates one or more fields of a project using JSON Patch operations. The fields supported by the project's patch validator are Name, StartDate, DueDate, and Archived. This endpoint allows for partial updates to a project without needing to send the entire project object. Date Values need to be set to UTC Timezone.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Project.

Request Body schema: application/json-patch+json
required

Test and Replace are required

string

Responses

Response Schema: application/json
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

name
string [ 0 .. 255 ] characters

The name of the project.

status
string or null

The current status of the project.

description
string or null

The description of the project. Returns HTML by default; use the /description endpoint to request plain text or Markdown.

archived
boolean

Whether the project has been archived.

startDate
string or null <date-time>

The date the project is scheduled to start.

dueDate
string or null <date-time>

The due date of the project.

completedDate
string or null <date-time>

The date and time the project was completed.

commentListId
integer or null <int32>

The identifier of the comment list associated with this project.

Array of objects (ProjectCustomField)

The list of custom fields and their values for this project.

Array of objects (Tag)

The tags applied to this project.

workRequestUID
integer or null <int32>

The unique identifier of the work request that generated this project, if any.

createdDateTime
string <date-time>

The date and time the project was created.

Request samples

Content type
application/json-patch+json
Example
[
]

Response samples

Content type
application/json
{
}

Gets signed file URLs for a project

Retrieves signed URLs for accessing the files attached to a project. These URLs are valid for a limited time and provide secure access to the requested files.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Project.

Responses

Response Schema: application/json
Array
fileVersionName
string

The display name of the file version.

fileId
integer <int32>

The unique identifier of the file.

fileVersionId
integer <int32>

The unique identifier of the specific file version.

url
string

The pre-signed URL for downloading the file.

urlExpiration
string <date-time>

The date and time at which the pre-signed URL expires.

assetId
integer or null <int32>

The identifier of the proof asset associated with this file, if applicable.

Response samples

Content type
application/json
[
]

Gets the reporting metrics for a project

Returns the aggregate and time metrics computed for a project, matching the equivalent in-app Report values. These are batch-refreshed, not real-time. If the project exists but its metrics have not yet been computed, metric fields are returned as null.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the project.

Responses

Response Schema: application/json
id
integer <int32>

The id of the project.

projectDuration
integer or null <int32>

Total elapsed duration of the project.

taskCount
integer or null <int32>

Number of tasks belonging to the project.

proofCount
integer or null <int32>

Number of proofs belonging to the project.

commentCount
integer or null <int32>

Number of comments on the project.

fileCount
integer or null <int32>

Number of files attached to the project.

totalTimeTracked
integer or null <int32>

Total time tracked against the project.

Array of objects or null (StatusTimeEntry)

Time spent in each status the project has passed through.

timeFromRequestToApproval
integer or null <int32>

Time elapsed from request to approval.

timeFromApprovalToProofSent
integer or null <int32>

Time elapsed from approval to the proof being sent.

levelOfEffort
integer or null <int32>

Level of effort recorded for the project.

timeTrackedPercent
number or null <decimal>

Percentage of the project's duration that had time tracked against it.

projectTime
integer or null <int32>

Total project time.

Response samples

Content type
application/json
{
}

Gets paginated descriptions for projects by ids

Gets paginated rich text descriptions for multiple projects by their unique identifiers. Use the format parameter to control whether descriptions are returned as HTML or plain text.

Authorizations:
Lytho Workflow Auth
query Parameters
format
string or null
Default: "HTML"
Value: "HTML"

The format for RTE description (e.g. HTML)

ids
required
Array of integers <int32> [ items <int32 > ]
Example: ids=0

A list of ids

page
required
integer <int32>
Default: 1

The page number to fetch

pageSize
required
integer
Default: 10
Enum: 10 20 30

The number of items per page

Responses

Response Schema: application/json
Array of objects (GetEntityDescriptionLookupResult)

The list of items on the current page.

page
integer <int32>

The current page number (1-based).

PagingSize (integer)

The number of items returned per page.

totalItemCount
integer <int32>

The total number of items across all pages.

totalPageCount
integer <int32>

The total number of pages based on TotalItemCount and PageSize.

Response samples

Content type
application/json
{
}

Gets a paged list of projects from an array of project ids

Retrieves the details of multiple projects by their unique identifiers. This endpoint supports paging only and does not support additional filtering by status or other project fields. For more granular querying, use the search endpoint.

Authorizations:
Lytho Workflow Auth
query Parameters
ids
required
Array of integers <int32> [ items <int32 > ]
Example: ids=0
page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

name
string [ 0 .. 255 ] characters

The name of the project.

status
string or null

The current status of the project.

description
string or null

The description of the project. Returns HTML by default; use the /description endpoint to request plain text or Markdown.

archived
boolean

Whether the project has been archived.

startDate
string or null <date-time>

The date the project is scheduled to start.

dueDate
string or null <date-time>

The due date of the project.

completedDate
string or null <date-time>

The date and time the project was completed.

commentListId
integer or null <int32>

The identifier of the comment list associated with this project.

Array of objects (ProjectCustomField)

The list of custom fields and their values for this project.

Array of objects (Tag)

The tags applied to this project.

workRequestUID
integer or null <int32>

The unique identifier of the work request that generated this project, if any.

createdDateTime
string <date-time>

The date and time the project was created.

Response samples

Content type
application/json
{
}

Gets all task IDs for a project

Returns the list of task IDs associated with a project. Use the Task endpoints to retrieve the full details of each task.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the project.

Responses

Response Schema: application/json
taskIDs
Array of integers <int32> [ items <int32 > ]

The list of task identifiers belonging to the project.

Response samples

Content type
application/json
{
}

Gets users associated with a project

Retrieves the list of users who are assigned to a specific project. These are Team Members assigned to the work, not reviewers on individual proofs.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Project.

Responses

Response Schema: application/json
Array
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32>

The unique identifier of the entity.

firstName
string [ 0 .. 30 ] characters

The user's first name.

lastName
string [ 0 .. 30 ] characters

The user's last name.

email
string [ 0 .. 255 ] characters

The user's email address.

UserStatusType (integer)

The user's current status within the account.

Response samples

Content type
application/json
[
]

Search for projects in a workflow

Searches for projects within a workflow based on specified criteria. Allows filtering by name, status, archive status, campaign, custom field values, and date ranges. Results reflect the current state of each project.

Authorizations:
Lytho Workflow Auth
query Parameters
name
string or null

Filters projects by name.

isArchived
required
boolean
Default: false

Filters projects based on their archived status.

status
string or null

Filters projects by their current status.

customFieldName
string or null

Filters projects by custom field name. Must be provided together with CustomFieldValue.

customFieldValue
string or null

Filters projects by custom field value. Must be provided together with CustomFieldName.

campaignId
integer or null <int32>

Filters projects by their parent campaign ID.

createdDateFrom
string or null <date-time>

Filters projects created on or after this date.

createdDateTo
string or null <date-time>

Filters projects created on or before this date.

completedDateFrom
string or null <date-time>

Filters projects completed on or after this date.

completedDateTo
string or null <date-time>

Filters projects completed on or before this date.

tagIds
Array of integers or null <int32>

Filters projects by tag IDs. AND/OR behavior is controlled by OperatorMode.

operatorMode
required
integer
Default: 1
Enum: 1 2

Defines how multiple criteria should be combined (e.g., AND, OR).

Responses

Response Schema: application/json
ids
Array of integers <int32> [ items <int32 > ]

The list of entity identifiers that match the search criteria.

totalCount
integer <int32>

The total number of matching entities.

Response samples

Content type
application/json
{
}

Preference

Gets a user preference by id

Retrieves a specific user preference by its unique identifier. The id parameter corresponds to the preference type, such as 'NotificationSettings' or 'DisplaySettings'. This endpoint allows you to view the details of a user's preference configuration.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Preference.

Responses

Response Schema: application/json
id
integer <int32>

The unique identifier of the entity.

name
string [ 0 .. 512 ] characters
defaultBooleanValue
boolean
defaultIntValue
integer or null <int32>
defaultStringValue
string or null [ 0 .. 2147483647 ] characters
asEnum
integer (PreferenceIds)
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 68 69 73 74 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 129 130 131 132 133 134 135 144 145 148 149 150 151 152

1 (WORKITEM_ASSIGNMENT_EMAIL), 2 (WORKITEM_ASSIGNMENT_INAPP), 3 (COMMENT_REPLY_INAPP), 4 (COMMENT_REPLY_EMAIL), 5 (PROOF_INVITATION_EMAIL), 6 (PROOF_INVITATION_INAPP), 7 (PROOF_RETURNED_EMAIL), 8 (PROOF_RETURNED_INAPP), 9 (SKIPPED_REVIEWER_EMAIL), 10 (SKIPPED_REVIEWER_INAPP), 11 (ROUTE_ENDDATE_EXPIRED_EMAIL), 12 (ROUTE_ENDDATE_EXPIRED_INAPP), 13 (RA_MENTION_EMAIL), 14 (RA_MENTION_INAPP), 15 (RA_COMMENT_REPLY_EMAIL), 16 (RA_COMMENT_REPLY_INAPP), 17 (MENTION_EMAIL), 18 (MENTION_INAPP), 19 (REVIEW_CANCELED_EMAIL), 20 (REVIEW_CANCELED_INAPP), 21 (STATUS_CHANGED_EMAIL), 22 (STATUS_CHANGED_INAPP), 23 (REQUEST_APPROVED_EMAIL), 24 (REQUEST_APPROVED_INAPP), 25 (WORKITEM_OVERDUE_EMAIL), 27 (WORKITEM_OVERDUE_INAPP), 28 (WORK_REQUEST_COMPLETED_EMAIL), 29 (WORK_REQUEST_COMPLETED_INAPP), 30 (WORK_REQUEST_SUBMITTED_EMAIL), 31 (WORK_REQUEST_SUBMITTED_INAPP), 32 (WORK_REQUEST_DUEDATE_CHANGED_EMAIL), 33 (WORK_REQUEST_DUEDATE_CHANGED_INAPP), 34 (PROOF_ROUTE_ENDDATE_CHANGED_EMAIL), 35 (PROOF_ROUTE_ENDDATE_CHANGED_INAPP), 36 (PROOF_ROUTE_ENDDATE_EXPIRED_EMAIL), 37 (PROOF_ROUTE_ENDDATE_EXPIRED_INAPP), 38 (EMAIL_TIMEZONE), 39 (WORKITEM_ARCHIVED_EMAIL), 40 (WORKITEM_ARCHIVED_INAPP), 41 (PROOF_INVITATION_SMS), 42 (WORK_REQUEST_COMPLETED_SMS), 43 (WORKITEM_ASSIGNMENT_FREQUENCY), 44 (SELF_REGISTRATION_ENABLED), 45 (SELF_REGISTRATION_DEFAULT_ROLE), 46 (TIME_TRACKING_ENABLED), 47 (TIME_TRACKING_CATEGORIES_ENABLED), 48 (TIME_TRACKING_WORK_REQUIRES_TIME_ENABLED), 49 (RESOURCE_SCHEDULING), 50 (AVAILABILITY_SUNDAY), 51 (AVAILABILITY_MONDAY), 52 (AVAILABILITY_TUESDAY), 53 (AVAILABILITY_WEDNESDAY), 54 (AVAILABILITY_THURSDAY), 55 (AVAILABILITY_FRIDAY), 56 (AVAILABILITY_SATURDAY), 57 (WORKITEM_FILESADDED_EMAIL), 58 (WORKITEM_FILESADDED_INAPP), 59 (COLLABORATE_RETURNED_PROOFS), 60 (ROUTE_UPDATED_BY_REVIEWER_EMAIL), 61 (ROUTE_UPDATED_BY_REVIEWER_INAPP), 62 (PROOF_SHARING), 63 (PROOF_SHARING_ON_BY_DEFAULT), 64 (PROOF_SHARING_STAKEHOLDERS_CAN_VIEW_OTHERS), 65 (AUTO_NUMBERING), 66 (AUTO_NUMBERING_PROJECTS), 68 (AUTO_NUMBERING_REQUESTS), 69 (AUTO_NUMBERING_CAMPAIGNS), 73 (REQUESTER_INSIGHTS), 74 (BUSINESS_DAYS), 83 (AUTO_NAMING), 84 (AUTO_NAMING_PROJECTS), 85 (AUTO_NAMING_CAMPAIGNS), 86 (PROOF_REVIEW_SUBMITTED_EMAIL), 87 (PROOF_REVIEW_SUBMITTED_IN_APP), 88 (TIMEZONE_DEFAULT), 89 (AUTOMATIC_REVIEW_REMINDER), 90 (REQUEST_SHARING_INAPP), 91 (REQUEST_SHARING_EMAIL), 92 (REQUEST_SHARING), 93 (COLLABORATE_ENABLE_BY_DEFAULT_NEW_PROOFS), 94 (SECURE_REVIEW_ENABLED), 95 (SECURE_REVIEW_ON_BY_DEFAULT), 96 (NOT_NEEDED_REVIEW_EMAIL), 97 (NOT_NEEDED_REVIEW_INAPP), 98 (AUTO_ADD_MEMBER_SEND_PROOF), 99 (AUTO_ADD_MEMBER_ADD_FILES), 100 (AUTO_ADD_MEMBER_UPDATE_STATUS), 101 (AUTO_ADD_MEMBER_CREATE_WORK_ITEM), 102 (AUTO_ADD_MEMBER_ADD_PROOF_ASSETS), 103 (BLOCKED_ITEM_NOTIFICATION_SUPPRESSION), 104 (REQUEST_MENTION_EMAIL), 105 (REQUEST_MENTION_INAPP), 106 (REQUEST_COMMENT_REPLY_EMAIL), 107 (REQUEST_COMMENT_REPLY_INAPP), 108 (REQUEST_OVERDUE_EMAIL), 109 (REQUEST_OVERDUE_INAPP), 110 (REQUEST_ARCHIVED_EMAIL), 111 (REQUEST_ARCHIVED_INAPP), 112 (PASSWORD_CRITERIA), 113 (PASSWORD_EXPIRATION), 114 (STOPWATCH_TIMER), 115 (START_DUE_TIMES), 116 (UNUSED_PREVIOUSLY_RESOURCE_MANAGEMENT), 117 (PROOF_SENT_FOR_REVIEW_EMAIL), 118 (PROOF_SENT_FOR_REVIEW_INAPP), 119 (COPY_REQUEST_FILES), 120 (WORKITEM_PRIORITY_CHANGED_EMAIL), 121 (WORKITEM_PRIORITY_CHANGED_INAPP), 122 (TIME_TRACKING_DEFAULT_CATEGORY), 123 (SHARE_ASSOCIATED_WORK_MEMBERS), 124 (RESOURCE_MANAGEMENT_SCALE), 125 (WORK_REQUEST_DELIVERABLE_FILE_ADDED_EMAIL), 126 (WORK_REQUEST_DELIVERABLE_FILE_ADDED_INAPP), 127 (CUSTOM_TRANSLATIONS), 129 (WORKITEM_EMOJI_REACTION_EMAIL), 130 (WORKITEM_EMOJI_REACTION_INAPP), 131 (REQUEST_EMOJI_REACTION_EMAIL), 132 (REQUEST_EMOJI_REACTION_INAPP), 133 (WORKITEM_DATE_CHANGED_EMAIL), 134 (WORKITEM_DATE_CHANGED_INAPP), 135 (CHANGE_REQUEST), 144 (CHANGE_REQUEST_SUBMITTED_FOR_ME_INAPP), 145 (CHANGE_REQUEST_SUBMITTED_FOR_ME_EMAIL), 148 (APP_INTEGRATIONS_SLACK), 149 (APP_INTEGRATIONS_MICROSOFT_TEAMS), 150 (APP_INTEGRATIONS_JIRA), 151 (REVIEW_ASSET_DOWNLOAD), 152 (REVIEW_ASSET_DOWNLOAD_BY_DEFAULT_NEW_PROOFS)

Response samples

Content type
application/json
{
}

Gets user preferences by array of ids

Retrieves multiple user preferences by their unique identifiers. The id parameter corresponds to the preference type, such as 'NotificationSettings' or 'DisplaySettings'. This endpoint allows you to view the details of a user's preference configuration.

Authorizations:
Lytho Workflow Auth
query Parameters
ids
required
Array of integers <int32> [ items <int32 > ]
Example: ids=0
page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
id
integer <int32>

The unique identifier of the entity.

name
string [ 0 .. 512 ] characters
defaultBooleanValue
boolean
defaultIntValue
integer or null <int32>
defaultStringValue
string or null [ 0 .. 2147483647 ] characters
asEnum
integer (PreferenceIds)
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 68 69 73 74 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 129 130 131 132 133 134 135 144 145 148 149 150 151 152

1 (WORKITEM_ASSIGNMENT_EMAIL), 2 (WORKITEM_ASSIGNMENT_INAPP), 3 (COMMENT_REPLY_INAPP), 4 (COMMENT_REPLY_EMAIL), 5 (PROOF_INVITATION_EMAIL), 6 (PROOF_INVITATION_INAPP), 7 (PROOF_RETURNED_EMAIL), 8 (PROOF_RETURNED_INAPP), 9 (SKIPPED_REVIEWER_EMAIL), 10 (SKIPPED_REVIEWER_INAPP), 11 (ROUTE_ENDDATE_EXPIRED_EMAIL), 12 (ROUTE_ENDDATE_EXPIRED_INAPP), 13 (RA_MENTION_EMAIL), 14 (RA_MENTION_INAPP), 15 (RA_COMMENT_REPLY_EMAIL), 16 (RA_COMMENT_REPLY_INAPP), 17 (MENTION_EMAIL), 18 (MENTION_INAPP), 19 (REVIEW_CANCELED_EMAIL), 20 (REVIEW_CANCELED_INAPP), 21 (STATUS_CHANGED_EMAIL), 22 (STATUS_CHANGED_INAPP), 23 (REQUEST_APPROVED_EMAIL), 24 (REQUEST_APPROVED_INAPP), 25 (WORKITEM_OVERDUE_EMAIL), 27 (WORKITEM_OVERDUE_INAPP), 28 (WORK_REQUEST_COMPLETED_EMAIL), 29 (WORK_REQUEST_COMPLETED_INAPP), 30 (WORK_REQUEST_SUBMITTED_EMAIL), 31 (WORK_REQUEST_SUBMITTED_INAPP), 32 (WORK_REQUEST_DUEDATE_CHANGED_EMAIL), 33 (WORK_REQUEST_DUEDATE_CHANGED_INAPP), 34 (PROOF_ROUTE_ENDDATE_CHANGED_EMAIL), 35 (PROOF_ROUTE_ENDDATE_CHANGED_INAPP), 36 (PROOF_ROUTE_ENDDATE_EXPIRED_EMAIL), 37 (PROOF_ROUTE_ENDDATE_EXPIRED_INAPP), 38 (EMAIL_TIMEZONE), 39 (WORKITEM_ARCHIVED_EMAIL), 40 (WORKITEM_ARCHIVED_INAPP), 41 (PROOF_INVITATION_SMS), 42 (WORK_REQUEST_COMPLETED_SMS), 43 (WORKITEM_ASSIGNMENT_FREQUENCY), 44 (SELF_REGISTRATION_ENABLED), 45 (SELF_REGISTRATION_DEFAULT_ROLE), 46 (TIME_TRACKING_ENABLED), 47 (TIME_TRACKING_CATEGORIES_ENABLED), 48 (TIME_TRACKING_WORK_REQUIRES_TIME_ENABLED), 49 (RESOURCE_SCHEDULING), 50 (AVAILABILITY_SUNDAY), 51 (AVAILABILITY_MONDAY), 52 (AVAILABILITY_TUESDAY), 53 (AVAILABILITY_WEDNESDAY), 54 (AVAILABILITY_THURSDAY), 55 (AVAILABILITY_FRIDAY), 56 (AVAILABILITY_SATURDAY), 57 (WORKITEM_FILESADDED_EMAIL), 58 (WORKITEM_FILESADDED_INAPP), 59 (COLLABORATE_RETURNED_PROOFS), 60 (ROUTE_UPDATED_BY_REVIEWER_EMAIL), 61 (ROUTE_UPDATED_BY_REVIEWER_INAPP), 62 (PROOF_SHARING), 63 (PROOF_SHARING_ON_BY_DEFAULT), 64 (PROOF_SHARING_STAKEHOLDERS_CAN_VIEW_OTHERS), 65 (AUTO_NUMBERING), 66 (AUTO_NUMBERING_PROJECTS), 68 (AUTO_NUMBERING_REQUESTS), 69 (AUTO_NUMBERING_CAMPAIGNS), 73 (REQUESTER_INSIGHTS), 74 (BUSINESS_DAYS), 83 (AUTO_NAMING), 84 (AUTO_NAMING_PROJECTS), 85 (AUTO_NAMING_CAMPAIGNS), 86 (PROOF_REVIEW_SUBMITTED_EMAIL), 87 (PROOF_REVIEW_SUBMITTED_IN_APP), 88 (TIMEZONE_DEFAULT), 89 (AUTOMATIC_REVIEW_REMINDER), 90 (REQUEST_SHARING_INAPP), 91 (REQUEST_SHARING_EMAIL), 92 (REQUEST_SHARING), 93 (COLLABORATE_ENABLE_BY_DEFAULT_NEW_PROOFS), 94 (SECURE_REVIEW_ENABLED), 95 (SECURE_REVIEW_ON_BY_DEFAULT), 96 (NOT_NEEDED_REVIEW_EMAIL), 97 (NOT_NEEDED_REVIEW_INAPP), 98 (AUTO_ADD_MEMBER_SEND_PROOF), 99 (AUTO_ADD_MEMBER_ADD_FILES), 100 (AUTO_ADD_MEMBER_UPDATE_STATUS), 101 (AUTO_ADD_MEMBER_CREATE_WORK_ITEM), 102 (AUTO_ADD_MEMBER_ADD_PROOF_ASSETS), 103 (BLOCKED_ITEM_NOTIFICATION_SUPPRESSION), 104 (REQUEST_MENTION_EMAIL), 105 (REQUEST_MENTION_INAPP), 106 (REQUEST_COMMENT_REPLY_EMAIL), 107 (REQUEST_COMMENT_REPLY_INAPP), 108 (REQUEST_OVERDUE_EMAIL), 109 (REQUEST_OVERDUE_INAPP), 110 (REQUEST_ARCHIVED_EMAIL), 111 (REQUEST_ARCHIVED_INAPP), 112 (PASSWORD_CRITERIA), 113 (PASSWORD_EXPIRATION), 114 (STOPWATCH_TIMER), 115 (START_DUE_TIMES), 116 (UNUSED_PREVIOUSLY_RESOURCE_MANAGEMENT), 117 (PROOF_SENT_FOR_REVIEW_EMAIL), 118 (PROOF_SENT_FOR_REVIEW_INAPP), 119 (COPY_REQUEST_FILES), 120 (WORKITEM_PRIORITY_CHANGED_EMAIL), 121 (WORKITEM_PRIORITY_CHANGED_INAPP), 122 (TIME_TRACKING_DEFAULT_CATEGORY), 123 (SHARE_ASSOCIATED_WORK_MEMBERS), 124 (RESOURCE_MANAGEMENT_SCALE), 125 (WORK_REQUEST_DELIVERABLE_FILE_ADDED_EMAIL), 126 (WORK_REQUEST_DELIVERABLE_FILE_ADDED_INAPP), 127 (CUSTOM_TRANSLATIONS), 129 (WORKITEM_EMOJI_REACTION_EMAIL), 130 (WORKITEM_EMOJI_REACTION_INAPP), 131 (REQUEST_EMOJI_REACTION_EMAIL), 132 (REQUEST_EMOJI_REACTION_INAPP), 133 (WORKITEM_DATE_CHANGED_EMAIL), 134 (WORKITEM_DATE_CHANGED_INAPP), 135 (CHANGE_REQUEST), 144 (CHANGE_REQUEST_SUBMITTED_FOR_ME_INAPP), 145 (CHANGE_REQUEST_SUBMITTED_FOR_ME_EMAIL), 148 (APP_INTEGRATIONS_SLACK), 149 (APP_INTEGRATIONS_MICROSOFT_TEAMS), 150 (APP_INTEGRATIONS_JIRA), 151 (REVIEW_ASSET_DOWNLOAD), 152 (REVIEW_ASSET_DOWNLOAD_BY_DEFAULT_NEW_PROOFS)

Response samples

Content type
application/json
{
}

Campaign

Search for campaigns in a workflow

Searches for campaigns within a workflow based on specified criteria. Allows filtering by name, status, archive status, custom field values, and date ranges. Results reflect the current state of each campaign.

Authorizations:
Lytho Workflow Auth
query Parameters
name
string or null

Filters campaigns by name.

isArchived
required
boolean
Default: false

Filters campaigns based on their archived status.

status
string or null

Filters campaigns by their current status.

customFieldName
string or null

Filters campaigns by custom field name. Must be provided together with CustomFieldValue.

customFieldValue
string or null

Filters campaigns by custom field value. Must be provided together with CustomFieldName.

createdDateFrom
string or null <date-time>

Filters campaigns created on or after this date.

createdDateTo
string or null <date-time>

Filters campaigns created on or before this date.

completedDateFrom
string or null <date-time>

Filters campaigns completed on or after this date.

completedDateTo
string or null <date-time>

Filters campaigns completed on or before this date.

tagIds
Array of integers or null <int32>

Filters campaigns by tag IDs. AND/OR behavior is controlled by OperatorMode.

operatorMode
required
integer
Default: 1
Enum: 1 2

Defines how multiple criteria should be combined (e.g., AND, OR).

Responses

Response Schema: application/json
ids
Array of integers <int32> [ items <int32 > ]

The list of entity identifiers that match the search criteria.

totalCount
integer <int32>

The total number of matching entities.

Response samples

Content type
application/json
{
}

Creates a new Campaign

Authorizations:
Lytho Workflow Auth
Request Body schema: application/json
required
name
required
string [ 0 .. 255 ] characters
description
string or null
startDate
string or null <date-time>
endDate
string or null <date-time>
dueDate
string or null <date-time>
campaignCustomStatusUID
integer or null <int32>
tagUIDs
Array of integers or null <int32>
userUIDs
Array of integers or null <int32>
Array of objects or null (CustomFieldValueCreateRequest)

Responses

Response Schema: application/json
campaignUID
integer <int32>
Response Schema: application/json
campaignUID
integer <int32>

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Gets a paged list of campaigns from an array of campaign ids

Retrieves the details of multiple campaigns by their unique identifiers. This endpoint supports paging only and does not support additional filtering by status or other campaign fields. For more granular querying, use the search endpoint.

Authorizations:
Lytho Workflow Auth
query Parameters
ids
required
Array of integers <int32> [ items <int32 > ]
Example: ids=0
page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

name
string [ 0 .. 255 ] characters
status
string or null
description
string or null
archived
boolean
startDate
string or null <date-time>
dueDate
string or null <date-time>
completedDate
string or null <date-time>
commentListId
integer or null <int32>
Array of objects (CampaignCustomField)
Array of objects (Tag)

The tags applied to this campaign.

workRequestUID
integer or null <int32>

The unique identifier of the work request that generated this campaign, if any.

createdDateTime
string <date-time>

The date and time the campaign was created.

Response samples

Content type
application/json
{
}

Gets Workflow comments on a campaign

Gets comments from the comment thread on the Workflow Campaign. These are campaign-level comments, not comments on individual projects or tasks within the campaign.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Campaign.

query Parameters
format
required
string
Default: 1
Value: "HTML"

1 (HTML)

page
required
integer <int32>
Default: 1
pageSize
required
integer
Default: 10
Enum: 10 20 30

10 (Default), 20 (Twenty), 30 (Thirty)

Responses

Response Schema: application/json
Array of objects (Comment)

The list of items on the current page.

page
integer <int32>

The current page number (1-based).

PagingSize (integer)

The number of items returned per page.

totalItemCount
integer <int32>

The total number of items across all pages.

totalPageCount
integer <int32>

The total number of pages based on TotalItemCount and PageSize.

Response samples

Content type
application/json
{
}

Gets the description of a campaign

Gets the rich text description for a campaign by its unique identifier. Use the format parameter to control whether the output is returned as HTML or plain text.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Campaign.

query Parameters
format
string or null
Default: "HTML"
Value: "HTML"

The output format of the description.

Responses

Response Schema: application/json
id
integer <int32>

The unique identifier of the entity.

description
string or null

The description content in the requested format (HTML, Markdown, or plain text).

Response samples

Content type
application/json
{
}

Gets a campaign by id

Retrieves the details of a specific campaign by its unique identifier. This includes information such as the campaign's current status, associated projects, and metadata.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Campaign.

Responses

Response Schema: application/json
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

name
string [ 0 .. 255 ] characters
status
string or null
description
string or null
archived
boolean
startDate
string or null <date-time>
dueDate
string or null <date-time>
completedDate
string or null <date-time>
commentListId
integer or null <int32>
Array of objects (CampaignCustomField)
Array of objects (Tag)

The tags applied to this campaign.

workRequestUID
integer or null <int32>

The unique identifier of the work request that generated this campaign, if any.

createdDateTime
string <date-time>

The date and time the campaign was created.

Response samples

Content type
application/json
{
}

Patches a Campaign using the provided values

Updates one or more fields of a campaign using JSON Patch operations. The fields supported by the campaign's patch validator are Name, StartDate, DueDate, and Archived. This endpoint allows for partial updates to a campaign without needing to send the entire campaign object. Date Values need to be set to UTC Timezone.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Campaign.

Request Body schema: application/json-patch+json
required

Test and Replace are required

string

Responses

Response Schema: application/json
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32> > 0

The unique identifier of the entity.

name
string [ 0 .. 255 ] characters
status
string or null
description
string or null
archived
boolean
startDate
string or null <date-time>
dueDate
string or null <date-time>
completedDate
string or null <date-time>
commentListId
integer or null <int32>
Array of objects (CampaignCustomField)
Array of objects (Tag)

The tags applied to this campaign.

workRequestUID
integer or null <int32>

The unique identifier of the work request that generated this campaign, if any.

createdDateTime
string <date-time>

The date and time the campaign was created.

Request samples

Content type
application/json-patch+json
Example
[
]

Response samples

Content type
application/json
{
}

Gets signed file URLs for a campaign

Retrieves signed URLs for accessing the files attached to a campaign. These URLs are valid for a limited time and provide secure access to the requested files.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Campaign.

Responses

Response Schema: application/json
Array
fileVersionName
string

The display name of the file version.

fileId
integer <int32>

The unique identifier of the file.

fileVersionId
integer <int32>

The unique identifier of the specific file version.

url
string

The pre-signed URL for downloading the file.

urlExpiration
string <date-time>

The date and time at which the pre-signed URL expires.

assetId
integer or null <int32>

The identifier of the proof asset associated with this file, if applicable.

Response samples

Content type
application/json
[
]

Gets the reporting metrics for a campaign

Returns the aggregate and time metrics computed for a campaign, matching the equivalent in-app Report values. These are batch-refreshed, not real-time. If the campaign exists but its metrics have not yet been computed, metric fields are returned as null.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the campaign.

Responses

Response Schema: application/json
id
integer <int32>

The id of the campaign.

campaignDuration
integer or null <int32>

Total elapsed duration of the campaign.

projectCount
integer or null <int32>

Number of projects belonging to the campaign.

taskCount
integer or null <int32>

Number of tasks belonging to the campaign.

proofCount
integer or null <int32>

Number of proofs belonging to the campaign.

commentCount
integer or null <int32>

Number of comments on the campaign.

fileCount
integer or null <int32>

Number of files attached to the campaign.

totalTimeTracked
integer or null <int32>

Total time tracked against the campaign.

Array of objects or null (StatusTimeEntry)

Time spent in each status the campaign has passed through.

timeFromRequestToApproval
integer or null <int32>

Time elapsed from request to approval.

timeFromApprovalToProofSent
integer or null <int32>

Time elapsed from approval to the proof being sent.

levelOfEffort
integer or null <int32>

Level of effort recorded for the campaign.

timeTrackedPercent
number or null <decimal>

Percentage of the campaign's duration that had time tracked against it.

Response samples

Content type
application/json
{
}

Gets paginated descriptions for campaigns by ids

Gets paginated rich text descriptions for multiple campaigns by their unique identifiers. Use the format parameter to control whether descriptions are returned as HTML or plain text.

Authorizations:
Lytho Workflow Auth
query Parameters
format
string or null
Default: "HTML"
Value: "HTML"

The format for RTE description (e.g. HTML)

ids
required
Array of integers <int32> [ items <int32 > ]
Example: ids=0

A list of ids

page
required
integer <int32>
Default: 1

The page number to fetch

pageSize
required
integer
Default: 10
Enum: 10 20 30

The number of items per page

Responses

Response Schema: application/json
Array of objects (GetEntityDescriptionLookupResult)

The list of items on the current page.

page
integer <int32>

The current page number (1-based).

PagingSize (integer)

The number of items returned per page.

totalItemCount
integer <int32>

The total number of items across all pages.

totalPageCount
integer <int32>

The total number of pages based on TotalItemCount and PageSize.

Response samples

Content type
application/json
{
}

Gets users associated with a campaign

Retrieves the list of users who are assigned to a specific campaign. These are Team Members assigned to the work, not reviewers on individual tasks within the campaign.

Authorizations:
Lytho Workflow Auth
path Parameters
id
required
integer <int32>

The id of the Campaign.

Responses

Response Schema: application/json
Array
accountId
integer <int32>

The identifier of the account this entity belongs to.

directLink
string or null

A direct URL to open this item in the Lytho Workflow UI.

id
integer <int32>

The unique identifier of the entity.

firstName
string [ 0 .. 30 ] characters

The user's first name.

lastName
string [ 0 .. 30 ] characters

The user's last name.

email
string [ 0 .. 255 ] characters

The user's email address.

UserStatusType (integer)

The user's current status within the account.

Response samples

Content type
application/json
[
]