API Reference

The Delesign API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base Url


										https://api.delesign.com
									

Sample Reference

The Delesign uses Bearer Authentication to authenticate requests. You can view and manage your API Token in the Delesign Account Settings.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Request: GET/v1/authorize

											
												Authorization: Bearer <token>
											
										

Example


										curl --location --request GET 'https://api.delesign.com/v1/authorize' \
										--header 'Authorization: Bearer YOUR-TOKEN-HERE' 
									

Success Response


										{
										    "message": "Authorized."
										}
									

Invalid Response


										{
										    "message": "Invalid token."
										}
									

Account Details

Retrieves the details of your account. You only need to supply the unique token identifier that was generated on your settings page.

Request: GET/v1/account

Parameter Type Position # Description
No Arguments

Example


										curl --location --request GET 'https://api.delesign.com/v1/account' \
										--header 'Authorization: Bearer YOUR-TOKEN-HERE' 
									

Response


										{
										    "user_registered": "2018-04-08 04:20:21",
										    "email": "youe@email.com",
										    "roles": [
										        "client",
										        "active_client"
										    ],
										    "first_name": "Kenny",
										    "last_name": "S",
										    "subscriptions": [
										        {
										            "sid": "1",
										            "sub_type": "graphic-designer",
										            "preference_type": "dd",
										            "designer": {
										                "id": "136",
										                "first_name": "Kenny",
										                "last_name": "S"
										            }
										        }
										    ],
										    "account_status": "active",
										    "address_1": "44555",
										    "city": "",
										    "state": "",
										    "zip_code": "",
										    "country": "",
										    "instagram": "",
										    "facebook": "",
										    "skype": "",
										    "twitter": "",
										    "company_name": "a",
										    "company_size": "Only Me",
										    "company_role": "a",
										    "problem_solving_type": "a",
										    "industries": [
										        "Agencies"
										    ],
										    "creative_assets": "",
										    "schedule": "Night Shift",
										    "referral_link": "https://delesign.com/?rfsn=",
										    "team_member": [
										        {
										            "email": "team@email.com",
										            "name": "John",
										            "code": "1_DJ2qa5WeCBHOeOGqJabC",
										            "status": "active",
										            "invite_expire": "2020-06-06 19:04:48"
										        }
										    ],
										    "designers": [
										        "Kenny S",
										        "John R"
										    ],
										    "projects": {
										        "company": {
										            "all": 2132,
										            "queue": 2104,
										            "active": 12,
										            "completed": 16
										        },
										        "own": {
										            "all": 571,
										            "queue": 543,
										            "active": 12,
										            "completed": 16
										        }
										    }
										}
									

All Projects

Returns a list of your projects. The projects are returned sorted by recently updated project, with the most recent project updated appearing first.

Request: GET/v1/projects/lists

Parameter Type Position # Description
type string body Optional Author of the projects. One of company, individual. Defaults to company
limit int body Optional Shows specific number projects. Minimum of 20. Defaults to 100
pagination int body Optional Pagination of current page. Defaults to 1
status string body Optional Project status. One of In Queue, Active , Completed. Defaults to null

Example


										curl --location --request GET 'https://api.delesign.com/v1/projects/lists' \
										--header 'Authorization: Bearer YOUR-TOKEN-HERE'
									

Response


										{
										    "has_more": true,
										    "data": [
										        {
										            "id": "15416",
										            "title": "My API project [15416]",
										            "title_text": "1 ",
										            "created": "2020-02-10 23:45:55",
										            "modified": "2020-09-16 14:17:47",
										            "status": "Completed",
										            "type": "Blog Images",
										            "dimension": "1",
										            "file_attachment": [],
										            "description": "This is the project description.",
										            "target_audience": "1",
										            "timeframe": "This is the project timeframe",
										            "inspiration": "This is the project inspiration",
										            "preference_type": "dd",
										            "author": "Kenny S",
										            "author_id": "1",
										            "file_url": "",
										            "cover_image": "",
										            "designer": "Justy R",
										            "designer_first_name": "Justy",
										            "designer_last_name": "R",
										            "designer_profile_picture": "",
										            "priority": "1",
										            "with_feedback": true,
										            "view_feedback": true
										        },
										        ...
										    ]
										}
    
									

Project Details

Retrieves the full details of an existing project that you or your team member has created. You need only supply the project id as the identifier.

Request: GET/v1/projects/view/{id}

Parameter Type Position # Description
id string URL Required Project ID.

Example


										curl --location --request GET 'https://api.delesign.com/v1/projects/view/26617' \
										--header 'Authorization: Bearer YOUR-TOKEN-HERE'
									

Response


									    {
									        "data": {
									            "id": "26617",
									            "title": "from the api [26617]",
									            "title_text": "from the api ",
									            "project_type": "designs",
									            "created": "22 Sep, 2020",
									            "modified": "22 Sep, 2020",
									            "file_attachment": [],
									            "author": "Kenny S",
									            "author_id": "1",
									            "preference_type": "dd",
									            "status": "In Queue",
									            "description": "Desc from api",
									            "target_audience": "",
									            "timeframe": "",
									            "inspiration": "",
									            "cover_image": "",
									            "project_free_assets_items": "",
									            "project_unsplash_items": "",
									            "file_types": "",
									            "file_types_edit": [],
									            "other_file_type": "",
									            "designer": [
									                {
									                    "full_name": "",
									                    "first_name": "",
									                    "last_name": "",
									                    "profile_picture": "",
									                    "designer_schedule": "none"
									                }
									            ],
									            "project_link": "",
									            "designs": [],
									            "design_type": "",
									            "design_type_other": "",
									            "video_script": "",
									            "screen_mockup": "",
									            "selection": "",
									            "credentials": [],
									            "brands": [],
									            "followers": [
									                {
									                    "id": "1",
									                    "full_name": "Kenny S",
									                    "first_name": "Kenny",
									                    "last_name": "S",
									                    "profile_picture": "https://s3.us-west-1.amazonaws.com/files.delesign/1596502075hOIgq/human-resources300x300.png"
									                }
									            ]
									        },
									        "stat": "found"
									    }
									

Creates a Project

Creates a new project on the user associated with the supplied token.

Request: POST/v1/projects/create

Parameter Type Position # Description
title int Body Required Title of the project.
type string Body Required Type of the project. One of Designs, Development. Defaults to Designs
category string Body Required - if project type is Designs Category of the project. One of
Graphic Design
  • Blog Images
  • Logo
  • Photo Editing
  • Web Banner
  • Social Media Posts and Ads
  • Web Ads
  • Podcast Cover
  • Ebook
  • Digital Brochure
  • Digital Magazine
  • Newsletter

Illustration
  • Digital Painting
  • Icons
  • Illustrations
  • Vector Illustration
  • Typography
  • Stickers

Prints
  • Business Card
  • Brochure or Flyer
  • Folder
  • Printed Ads
  • Sales Sheet
  • Magazines
  • Tshirt Designs
  • Totes, Mugs, Bags etc
  • Banner
  • Billboard
  • Vehicle Wrap
  • Event Backdrop
  • Packaging and Label
  • Book Cover & Layout
  • Restaurant Menu

Web and App Designs
  • Website Design Mockup
  • App Design Mockup

Video & Motion Graphics
  • Video Editing
  • Motion Graphics
  • 2D Animation
  • Character Animation
  • Animated GIFs
description string Body Required Description of the project.
dimension string Body Optional Dimension of the project.
target_audience string Body Optional Target audience of the project.
timeframe string Body Optional Timeframe of the project.
inspiration string Body Optional Inspiration of the project.
script string Body Optional Video script of the project. This will be required if project type is one of Video Editing, Motion Graphics, 2D Animation, Character Animation, Animated GIFs
mockup_type string Body Optional The mockup type. This will be required if project type is one of Website Design Mockup, App Design Mockup. One of Web - Desktop, Web - Mobile, Mobile App, None Specified
screen_mockup string Body Optional The page or screen for this mockup. This will be required if project type is one of Website Design Mockup, App Design Mockup
file_attachment array or string Body Optional File attachment for the project. Must be a file url or an array of file urls.
file_types array or string Body Optional File types of the project. One of PNG, JPG, PDF, PPT, AI, EPS, PSD. Defaults to PSD.

Example


										curl --location --request POST 'https://api.delesign.com/v1/projects/create' \
										--header 'Authorization: Bearer YOUR-TOKEN-HERE'
										--form 'title=Project A' \
										--form 'category=Blog Images' \
										--form 'description=This is my description.'
									

Response


									    {
									        "data": {
									            "id": "26634",
									            "title": "Project A [26634]",
									            "title_text": "Project A ",
									            "project_type": "designs",
									            "created": "22 Sep, 2020",
									            "modified": "22 Sep, 2020",
									            "file_attachment": [],
									            "author": "Kenny S",
									            "author_id": "1",
									            "preference_type": "dd",
									            "status": "In Queue",
									            "description": "This is my description.",
									            "target_audience": "",
									            "timeframe": "",
									            "inspiration": "",
									            "cover_image": "",
									            "project_free_assets_items": "",
									            "project_unsplash_items": [],
									            "file_types": "PSD",
									            "file_types_edit": [
									                "PSD"
									            ],
									            "other_file_type": "",
									            "designer": [
									                {
									                    "full_name": "",
									                    "first_name": "",
									                    "last_name": "",
									                    "profile_picture": "",
									                    "designer_schedule": "none"
									                }
									            ],
									            "project_link": "",
									            "designs": [],
									            "design_type": "Blog Images",
									            "design_type_other": "",
									            "video_script": "",
									            "screen_mockup": "",
									            "selection": "",
									            "credentials": [],
									            "brands": [],
									            "followers": [
									                {
									                    "id": "1",
									                    "full_name": "Kenny S",
									                    "first_name": "Kenny",
									                    "last_name": "S",
									                    "profile_picture": "https://s3.us-west-1.amazonaws.com/files.delesign/1596502075hOIgq/human-resources300x300.png"
									                }
									            ]
									        },
									        "stat": "found"
									    }
									

Update a Project

Updates the specified project by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Request: POST/v1/projects/edit/{id}

Parameter Type Position # Description
id int URL Required ID of the project.
title int Body Required Title of the project.
category string Body Required - if project type is Designs Category of the project. One of
Graphic Design
  • Blog Images
  • Logo
  • Photo Editing
  • Web Banner
  • Social Media Posts and Ads
  • Web Ads
  • Podcast Cover
  • Ebook
  • Digital Brochure
  • Digital Magazine
  • Newsletter

Illustration
  • Digital Painting
  • Icons
  • Illustrations
  • Vector Illustration
  • Typography
  • Stickers

Prints
  • Business Card
  • Brochure or Flyer
  • Folder
  • Printed Ads
  • Sales Sheet
  • Magazines
  • Tshirt Designs
  • Totes, Mugs, Bags etc
  • Banner
  • Billboard
  • Vehicle Wrap
  • Event Backdrop
  • Packaging and Label
  • Book Cover & Layout
  • Restaurant Menu

Web and App Designs
  • Website Design Mockup
  • App Design Mockup

Video & Motion Graphics
  • Video Editing
  • Motion Graphics
  • 2D Animation
  • Character Animation
  • Animated GIFs
description string Body Required Description of the project.
dimension string Body Optional Dimension of the project.
target_audience string Body Optional Target audience of the project.
timeframe string Body Optional Timeframe of the project.
inspiration string Body Optional Inspiration of the project.
script string Body Optional Video script of the project. This will be required if project type is one of Video Editing, Motion Graphics, 2D Animation, Character Animation, Animated GIFs
mockup_type string Body Optional The mockup type. This will be required if project type is one of Website Design Mockup, App Design Mockup. One of Web - Desktop, Web - Mobile, Mobile App, None Specified
screen_mockup string Body Optional The page or screen for this mockup. This will be required if project type is one of Website Design Mockup, App Design Mockup
file_attachment array or string Body Optional File attachment for the project. Must be a file url or an array of file urls.
file_types array or string Body Optional Target audience of the project. One of PNG, JPG, PDF, PPT, AI, EPS, PSD. Defaults to PSD.

Example


										curl --location --request POST 'https://api.delesign.com/v1/projects/edit' \
										--header 'Authorization: Bearer YOUR-TOKEN-HERE'
										--form 'title=Project B' \
										--form 'category=Web Banner' \
										--form 'description=This is my new description.'
									

Response


										{
										    "data": {
										        "id": "26634",
										        "title": "Project B [26634]",
										        "title_text": "Project B ",
										        "project_type": "designs",
										        "created": "22 Sep, 2020",
										        "modified": "22 Sep, 2020",
										        "file_attachment": [],
										        "author": "Kenny S",
										        "author_id": "1",
										        "preference_type": "dd",
										        "status": "In Queue",
										        "description": "This is my new description.",
										        "target_audience": "",
										        "timeframe": "",
										        "inspiration": "",
										        "cover_image": "",
										        "project_free_assets_items": "",
										        "project_unsplash_items": [],
										        "file_types": "PSD",
										        "file_types_edit": [
										            "PSD"
										        ],
										        "other_file_type": "",
										        "designer": [
										            {
										                "full_name": "",
										                "first_name": "",
										                "last_name": "",
										                "profile_picture": "",
										                "designer_schedule": "none"
										            }
										        ],
										        "project_link": "",
										        "designs": [],
										        "design_type": "Web Banner",
										        "design_type_other": "",
										        "video_script": "",
										        "screen_mockup": "",
										        "selection": "",
										        "credentials": [],
										        "brands": [],
										        "followers": [
										            {
										                "id": "1",
										                "full_name": "Kenny S",
										                "first_name": "Kenny",
										                "last_name": "S",
										                "profile_picture": "https://s3.us-west-1.amazonaws.com/files.delesign/1596502075hOIgq/human-resources300x300.png"
										            }
										        ]
										    },
										    "stat": "found"
										}
									

Delete the project

Permanently deletes a project and all of the associated messages and files. It cannot be undone.

Request DELETE/v1/projects/delete/{id}

Parameter Type Position # Description
id string URL Required ID of the project.

Example


										curl --location --request DELETE 'https://api.delesign.com/v1/projects/delete/26634' \
										--header 'Authorization: Bearer YOUR-TOKEN-HERE'
									

Response


										{
										    "message": "Success."
										}
									

Create Message

Sends a message on the project on behalf of your Delesign account.

Request POST/v1/messages/create/{id}

Parameter Type Position # Description
id int URL Required ID of the project.
message string Body Required Message of the project.
file_attachment string Body Optional File attachment of the project.

Example


										curl --location --request POST 'https://api.delesign.com/v1/messages/create/26632' \
										--header 'Authorization: Bearer YOUR-TOKEN-HERE'
									

Response


										{
										    "message": "Success."
										}