Lytho's API enables developers to build applications with access to Lytho Workflow. This enables users to fully integrate Lytho in their workflow and processes. 


Features described in this article are not included in all subscription plans. Contact our Support Team for further assistance.



TABLE OF CONTENTS



Client ID & Client Secret

To access the Open API, you'll need to generate an access token using a Client ID and Client Secret. These can be generated within Lytho Workflow by navigating to Account Settings > Open API. 


The Client Secret will only be displayed once after generation. Be sure to store it somewhere safe.


open api settings


If you misplace your Client Secret, a new one can be generated by selecting Reset Client Secret. Resetting the Client Secret will break any existing integrations that have been established. 





Technical Documentation

You can find the technical documentation for Lytho Workflow's API here.




API End Points

The following end points have been created for the API:


WorkRequest
  • Retrieve Deliverable Files
  • Retrieve Work Request by ID
  • Retrieve Multiple Work Requests by IDs
  • Retrieve Work Request Users
  • Search Work Requests
Task
  • Retrieve Task by ID
  • Retrieve Task Files
  • Retrieve Multiple Tasks by IDs
  • Retrieve Task Users
  • Search Tasks
Proof
  • Retrieve Proof by ID
  • Retrieve Proof Files
  • Retrieve Multiple Proofs by IDs
  • Retrieve Proof Users
  • Search Proofs
Project
  • Retrieve Project by ID
  • Retrieve Project Files
  • Retrieve Multiple Projects by IDs
  • Retrieve Project Users
  • Search Projects
Campaign
  • Search Campaigns




Use Cases Examples

  • Project & Task Management (Jira, Asana, Smartsheet, etc.)
  • Sales & CRM (Salesforce, HubSpot, etc.)
  • Calendars & Scheduling (Outlook calendar, Google calendar, etc.)
  • File Storage (Google Drive, OneDrive, Dropbox, Box, etc.) & Digital Asset Management (DAM)
  • Other Potential Integrations
    • Slack or Microsoft Teams 
    • ERP or Financial Systems (Workday, NetSuite, etc.) 
    • Customer Support Platforms (Zendesk, ServiceNow, etc.)




Error Handling 

The Lytho API uses HTTP status codes to reflect a successful or unsuccessful request. 2XX status codes are successful requests 4XX/5XX status codes represent an error took place. If you receive an error status code, check the body for an error code and message.


Status code
DescriptionMost likely cause
2XXSuccessful request
400Bad requestInvalid / missing data
401UnauthorizedInvalid / missing API key
403ForbiddenPerforming an action that's not permitted
404Not found

The resource doesn’t exist / wrong

endpoint 

409Conflict

Trying to overwrite a resource that

already exists

429Too many requestsHit an API rate limit
500Internal server errorAn error occurred on Lytho side