Skip to content
OpenParablePublic APIs

IllumiDesk API

by illumidesk.com

API keyHTTPSOpen Data
Open documentation ↗

Overview

The AI support platform built for Shopify. Product search, order tracking, cart management, and multi-channel messaging.

IllumiDesk is an open data API from illumidesk.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 143 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Category
Open Data
Base URL
https://api.illumidesk.com
Version
1.0
Endpoints
143
OpenAPI
Specification ↗
Spec updated
2018-02-19

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.illumidesk.com/v1/me" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://api.illumidesk.com/v1/me", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.illumidesk.com/v1/me",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/auth/jwt-token-auth/Create JSON Web Token (JWT)
POST/auth/jwt-token-refresh/Refresh a JSON Web Token (JWT)
POST/auth/jwt-token-verify/Validate JSON Web Token (JWT)
GET/auth/login/{provider}/oauth_login
POST/auth/register/Register a user
GET/v1/meA convenience endpoint that is equivalent to GET /v1/users/profiles/<my user id>/
GET/v1/servers/options/server-size/Retrieve available server sizes
POST/v1/servers/options/server-size/Create a new server size item
GET/v1/servers/options/server-size/{size}/Get a server size by id
PUT/v1/servers/options/server-size/{size}/Replace a server size by id
PATCH/v1/servers/options/server-size/{size}/Update a server size by id
DELETE/v1/servers/options/server-size/{size}/Delete a server size by id
GET/v1/teams/Get teams
POST/v1/teams/Create a new team
GET/v1/teams/{team}/Get a team
PUT/v1/teams/{team}/Replace a team
PATCH/v1/teams/{team}/Update a team
DELETE/v1/teams/{team}/Delete a team
GET/v1/teams/{team}/billing/invoices/Get team invoices
GET/v1/teams/{team}/billing/invoices/{id}/Get an invoice
GET/v1/teams/{team}/billing/invoices/{invoice_id}/invoice-items/Get team invoice items for a given invoice.
GET/v1/teams/{team}/billing/invoices/{invoice_id}/invoice-items/{id}Get a specific team InvoiceItem.
GET/v1/teams/{team}/billing/subscriptions/Get active team subscriptons
POST/v1/teams/{team}/billing/subscriptions/Create a new team subscription
GET/v1/teams/{team}/billing/subscriptions/{id}/Get team subscriptions
DELETE/v1/teams/{team}/billing/subscriptions/{id}/Delete a subscription
GET/v1/teams/{team}/groups/Get team groups
GET/v1/teams/{team}/groups/{group}/Get team group
PUT/v1/teams/{team}/groups/{group}/Patch team group
PATCH/v1/teams/{team}/groups/{group}/Patch team group
DELETE/v1/teams/{team}/groups/{group}/Delete team group
POST/v1/teams/{team}/groups/{group}/add/Add user to group
POST/v1/teams/{team}/groups/{group}/remove/User removed from group
GET/v1/users/profiles/Get user list
POST/v1/users/profiles/Create new user
GET/v1/users/profiles/{user}/Retrieve a user
PATCH/v1/users/profiles/{user}/Update a user
DELETE/v1/users/profiles/{user}/Delete a user
GET/v1/users/{user}/api-key/Retrieve account's API key
GET/v1/users/{user}/avatar/Retrieve user's avatar
POST/v1/users/{user}/avatar/Add user avatar
PATCH/v1/users/{user}/avatar/Update a project file
DELETE/v1/users/{user}/avatar/Delete avatar
GET/v1/users/{user}/emails/Retrieve account email addresses
POST/v1/users/{user}/emails/Create an email address
GET/v1/users/{user}/emails/{email_id}/Retrieve a user's email addresses
PUT/v1/users/{user}/emails/{email_id}/Replace an email address
PATCH/v1/users/{user}/emails/{email_id}/Update an email address
DELETE/v1/users/{user}/emails/{email_id}/Delete an email address
GET/v1/users/{user}/ssh-key/Retrieve an SSH key
POST/v1/users/{user}/ssh-key/reset/Recreate an SSH key
GET/v1/{namespace}/billing/cards/Get credit cards
POST/v1/{namespace}/billing/cards/Create new credit card
GET/v1/{namespace}/billing/cards/{id}/Get credit card by id
PUT/v1/{namespace}/billing/cards/{id}/Replace a credit card
PATCH/v1/{namespace}/billing/cards/{id}/Update a credit card
DELETE/v1/{namespace}/billing/cards/{id}/Delete a credit card
GET/v1/{namespace}/billing/invoices/Get invoices
GET/v1/{namespace}/billing/invoices/{id}/Get an invoice
GET/v1/{namespace}/billing/invoices/{invoice_id}/invoice-items/Get invoice items for a given invoice.
GET/v1/{namespace}/billing/invoices/{invoice_id}/invoice-items/{id}Get a specific InvoiceItem.
GET/v1/{namespace}/billing/plans/Get billing plans
GET/v1/{namespace}/billing/plans/{id}/Get a billing plan
GET/v1/{namespace}/billing/subscriptions/Get active subscriptons
POST/v1/{namespace}/billing/subscriptions/Create a new subscription
GET/v1/{namespace}/billing/subscriptions/{id}/Get a subscriptions
DELETE/v1/{namespace}/billing/subscriptions/{id}/Delete a subscription
GET/v1/{namespace}/notifications/Get notifications of all types and entities for the authenticated user.
PATCH/v1/{namespace}/notifications/Mark a list of notifications as either read or unread.
GET/v1/{namespace}/notifications/entity/{entity}Get notifications of all types and entities for the authenticated user.
PATCH/v1/{namespace}/notifications/entity/{entity}Mark a list of notifications as either read or unread.
GET/v1/{namespace}/notifications/settings/Retrieve global notification settings for the authenticated user
POST/v1/{namespace}/notifications/settings/Create global notification settings
PATCH/v1/{namespace}/notifications/settings/Modify global notification settings.
GET/v1/{namespace}/notifications/settings/entity/{entity}Retrieve global notification settings for the authenticated user
POST/v1/{namespace}/notifications/settings/entity/{entity}Create global notification settings
PATCH/v1/{namespace}/notifications/settings/entity/{entity}Modify global notification settings.
GET/v1/{namespace}/notifications/{notification_id}Retrieve a specific notification.
PATCH/v1/{namespace}/notifications/{notification_id}Mark a specific notification as either read or unread.
GET/v1/{namespace}/oauth/applications/Retrieve oauth applications
POST/v1/{namespace}/oauth/applications/Create a new OAuth2 application
GET/v1/{namespace}/oauth/applications/{application}/Get an application by id
PUT/v1/{namespace}/oauth/applications/{application}/Replace an application by id
PATCH/v1/{namespace}/oauth/applications/{application}/Update an application by id
DELETE/v1/{namespace}/oauth/applications/{application}/Delete an application by id
GET/v1/{namespace}/projects/Get available projects
POST/v1/{namespace}/projects/Create a new project
POST/v1/{namespace}/projects/project-copy/Copy a project to your own account.
GET/v1/{namespace}/projects/{project}/Get a project
PUT/v1/{namespace}/projects/{project}/Replace a project
PATCH/v1/{namespace}/projects/{project}/Update a project
DELETE/v1/{namespace}/projects/{project}/Delete a project
GET/v1/{namespace}/projects/{project}/collaborators/Get project collaborators
POST/v1/{namespace}/projects/{project}/collaborators/Create project collaborators
GET/v1/{namespace}/projects/{project}/collaborators/{collaborator}/Get a project collaborator
PATCH/v1/{namespace}/projects/{project}/collaborators/{collaborator}/Update project collaborator
DELETE/v1/{namespace}/projects/{project}/collaborators/{collaborator}/Delete a project collaborator
GET/v1/{namespace}/projects/{project}/deployments/Retrieve deployments
POST/v1/{namespace}/projects/{project}/deployments/Create a new deployment
GET/v1/{namespace}/projects/{project}/deployments/{deployment}/Retrieve a deployment

Showing the first 100 of 143 endpoints; the full list is in the documentation.

Questions

Does the IllumiDesk API need an API key?

Yes. The IllumiDesk API uses API key authentication; the documentation explains how to get credentials.

Does the IllumiDesk API support HTTPS?

Yes, the IllumiDesk API is served over HTTPS.

How many endpoints does the IllumiDesk API have?

Its OpenAPI description lists 143 endpoints in version 1.0. The first 100 are shown on this page.

What are alternatives to the IllumiDesk API?

Other Open Data APIs include Search Services, Wayback API, Wikipedia, Nasdaq Data Link, University of Oslo.

Compare alternatives →

Search Services

Open Data

API for Internet Archive's Search-related services

No auth3 endpoints

Wayback API

Open Data

API for Internet Archive's Wayback Machine

No auth2 endpoints

Wikipedia

Open Data

Mediawiki Encyclopedia

No auth

Nasdaq Data Link

Open Data

The source for financial, economic, and alternative datasets, serving investment professionals.

API key

University of Oslo

Open Data

Courses, lecture videos, detailed information for courses etc. for the University of Oslo (Norway)

No auth

Data API

Open Data

Serves the Clever Data API

OAuth44 endpoints

Listed from APIs.guru (CC0).