# IllumiDesk API

> IllumiDesk API on Apizie: 143 endpoints (Create JSON Web Token (JWT), Refresh a JSON Web Token (JWT), Validate JSON Web Token (JWT), GET /auth/login/{provider}/, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/open-data:illumidesk/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:illumidesk`
- Category: Open Data
- Status: byok
- Source: https://illumidesk.com
- Page: https://apizie.tech/api/open-data/illumidesk
- OpenAPI: https://apizie.tech/api/open-data/illumidesk/openapi.json



## Endpoints

### Create JSON Web Token (JWT)
`POST https://apizie.tech/v1/open-data:illumidesk/auth-jwt-token-auth` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Refresh a JSON Web Token (JWT)
`POST https://apizie.tech/v1/open-data:illumidesk/auth-jwt-token-refresh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Validate JSON Web Token (JWT)
`POST https://apizie.tech/v1/open-data:illumidesk/auth-jwt-token-verify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /auth/login/{provider}/
`GET https://apizie.tech/v1/open-data:illumidesk/oauth-login` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| provider | string | yes | OAuth2 provider |

### Register a user
`POST https://apizie.tech/v1/open-data:illumidesk/auth-register` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### A convenience endpoint that is equivalent to GET /v1/users/profiles/ /
`GET https://apizie.tech/v1/open-data:illumidesk/me` (byok)

### Retrieve available server sizes
`GET https://apizie.tech/v1/open-data:illumidesk/servers-options-sizes-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | Set limit when retrieving items. |
| offset | string | no | Offset when retrieving items. |
| ordering | string | no | Set order when retrieving items. |

### Create a new server size item
`POST https://apizie.tech/v1/open-data:illumidesk/servers-options-server-size-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a server size by id
`GET https://apizie.tech/v1/open-data:illumidesk/servers-options-resources-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| size | string | yes | Server size unique identifier expressed as UUID or name. |

### Replace a server size by id
`POST https://apizie.tech/v1/open-data:illumidesk/servers-options-server-size-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| size | string | yes | Server size unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Update a server size by id
`POST https://apizie.tech/v1/open-data:illumidesk/servers-options-server-size-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| size | string | yes | Server size unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Delete a server size by id
`POST https://apizie.tech/v1/open-data:illumidesk/servers-options-server-size-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| size | string | yes | Server size unique identifier expressed as UUID or name. |

### Get teams
`GET https://apizie.tech/v1/open-data:illumidesk/teams-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | Limit when getting data. |
| offset | string | no | Offset when getting data. |

### Create a new team
`POST https://apizie.tech/v1/open-data:illumidesk/teams-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get a team
`GET https://apizie.tech/v1/open-data:illumidesk/teams-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |

### Replace a team
`POST https://apizie.tech/v1/open-data:illumidesk/teams-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Update a team
`POST https://apizie.tech/v1/open-data:illumidesk/teams-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Delete a team
`POST https://apizie.tech/v1/open-data:illumidesk/teams-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |

### Get team invoices
`GET https://apizie.tech/v1/open-data:illumidesk/teams-billing-invoices-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| limit | string | no | Limit when getting items. |
| offset | string | no | Offset when getting items. |

### Get an invoice
`GET https://apizie.tech/v1/open-data:illumidesk/teams-billing-invoices-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| id | string | yes | Invoice unique identifier expressed as UUID. |

### Get team invoice items for a given invoice.
`GET https://apizie.tech/v1/open-data:illumidesk/teams-billing-invoice-items-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| invoice_id | string | yes | Invoice id, expressed as UUID. |
| limit | string | no | Limit when getting items. |
| offset | string | no | Offset when getting items. |
| ordering | string | no | Ordering when getting items. |

### Get a specific team InvoiceItem.
`GET https://apizie.tech/v1/open-data:illumidesk/teams-billing-invoice-items-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| invoice_id | string | yes | Invoice id, expressed as UUID. |
| id | string | yes | InvoiceItem id, expressed as UUID. |

### Get active team subscriptons
`GET https://apizie.tech/v1/open-data:illumidesk/teams-billing-subscriptions-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| limit | string | no | Limit when getting items. |
| offset | string | no | Offset when getting items. |
| ordering | string | no | Ordering when getting items. |

### Create a new team subscription
`POST https://apizie.tech/v1/open-data:illumidesk/teams-billing-subscriptions-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Get team subscriptions
`GET https://apizie.tech/v1/open-data:illumidesk/teams-billing-subscriptions-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| id | string | yes | Unique identifier expressed as UUID. |

### Delete a subscription
`POST https://apizie.tech/v1/open-data:illumidesk/teams-billing-subscriptions-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| id | string | yes | Subscription unique identifier expressed as UUID. |

### Get team groups
`GET https://apizie.tech/v1/open-data:illumidesk/teams-groups-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| limit | string | no | Limit when getting data. |
| offset | string | no | Offset when getting data. |

### Get team group
`GET https://apizie.tech/v1/open-data:illumidesk/teams-groups-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| group | string | yes | Group unique identifier expressed as UUID or name. |

### Patch team group
`POST https://apizie.tech/v1/open-data:illumidesk/teams-groups-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| group | string | yes | Group unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Patch team group
`POST https://apizie.tech/v1/open-data:illumidesk/teams-groups-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| group | string | yes | Group unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Delete team group
`POST https://apizie.tech/v1/open-data:illumidesk/teams-groups-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| group | string | yes | Group unique identifier expressed as UUID or name. |

### Add user to group
`POST https://apizie.tech/v1/open-data:illumidesk/teams-groups-add-to-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| group | string | yes | Group unique identifier expressed as UUID or name. |

### User removed from group
`POST https://apizie.tech/v1/open-data:illumidesk/teams-groups-remove-from-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| team | string | yes | Team unique identifier expressed as UUID or name. |
| group | string | yes | Group unique identifier expressed as UUID or name. |

### Get user list
`GET https://apizie.tech/v1/open-data:illumidesk/users-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | Limit user list. |
| offset | string | no | Offset when getting users. |
| username | string | no | User username. |
| email | string | no | User email. |
| ordering | string | no | Ordering when getting users. |

### Create new user
`POST https://apizie.tech/v1/open-data:illumidesk/users-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a user
`GET https://apizie.tech/v1/open-data:illumidesk/users-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | Unique identifier expressed as UUID or username. |

### Update a user
`POST https://apizie.tech/v1/open-data:illumidesk/users-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | User unique identifier expressed as UUID or username. |
| body | object | no | JSON request body |

### Delete a user
`POST https://apizie.tech/v1/open-data:illumidesk/users-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | User identifier expressed as UUID or username. |

### Retrieve account's API key
`GET https://apizie.tech/v1/open-data:illumidesk/users-api-key-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | User unique identifier expressed as UUID or username. |

### Retrieve user's avatar
`GET https://apizie.tech/v1/open-data:illumidesk/user-avatar-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | User unique identifier expressed as UUIDor username. |

### Add user avatar
`POST https://apizie.tech/v1/open-data:illumidesk/user-avatar-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | User unique identifier expressed as UUID or username. |

### Update a project file
`POST https://apizie.tech/v1/open-data:illumidesk/user-avatar-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | User unique identifier expressed as UUID or username. |

### Delete avatar
`POST https://apizie.tech/v1/open-data:illumidesk/user-avatar-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | User unique identifier expressed as UUID or username. |

### Retrieve account email addresses
`GET https://apizie.tech/v1/open-data:illumidesk/users-emails-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | User unique identifier as expressed as UUID or username. |
| limit | string | no | Limite when getting email list. |
| offset | string | no | Offset when getting email list. |
| ordering | string | no | Ordering when getting email list. |

### Create an email address
`POST https://apizie.tech/v1/open-data:illumidesk/users-emails-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | User unique identifier expressed as UUID or username. |
| body | object | no | JSON request body |

### Retrieve a user's email addresses
`GET https://apizie.tech/v1/open-data:illumidesk/users-emails-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| email_id | string | yes | Email unique identifier expressed as UUID. |
| user | string | yes | User unique identifier expressed as UUID or username. |

### Replace an email address
`POST https://apizie.tech/v1/open-data:illumidesk/users-emails-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| email_id | string | yes | Email unique identifier expressed as UUID. |
| user | string | yes | User unique identifier expressed as UUID or username. |
| body | object | no | JSON request body |

### Update an email address
`POST https://apizie.tech/v1/open-data:illumidesk/users-emails-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| email_id | string | yes | Email unique identifier expressed as UUID. |
| user | string | yes | User unique identifier expressed as UUID or username. |
| body | object | no | JSON request body |

### Delete an email address
`POST https://apizie.tech/v1/open-data:illumidesk/users-emails-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| email_id | string | yes | Email unique identifier expressed as UUID. |
| user | string | yes | User unique identifier expressed as UUID or username. |

### Retrieve an SSH key
`GET https://apizie.tech/v1/open-data:illumidesk/users-ssh-key-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | User unique identifier expressed as UUID or username. |

### Recreate an SSH key
`POST https://apizie.tech/v1/open-data:illumidesk/users-ssh-key-reset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user | string | yes | User unique identifier expressed as UUID or username. |

### Get credit cards
`GET https://apizie.tech/v1/open-data:illumidesk/billing-cards-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| limit | string | no | Set limit when retrieving credit or debit cards. |
| offset | string | no | Set offset when retriving cards. |
| ordering | string | no | Order when retrieving cards. |

### Create new credit card
`POST https://apizie.tech/v1/open-data:illumidesk/billing-cards-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| body | object | no | JSON request body |

### Get credit card by id
`GET https://apizie.tech/v1/open-data:illumidesk/billing-cards-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| id | string | yes | User unique identifier expressed as UUID. |

### Replace a credit card
`POST https://apizie.tech/v1/open-data:illumidesk/billing-cards-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| id | string | yes |  |
| body | object | no | JSON request body |

### Update a credit card
`POST https://apizie.tech/v1/open-data:illumidesk/billing-cards-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| id | string | yes | Card unique identifier. |
| body | object | no | JSON request body |

### Delete a credit card
`POST https://apizie.tech/v1/open-data:illumidesk/billing-cards-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| id | string | yes | Card unique identifier expressed as UUID. |

### Get invoices
`GET https://apizie.tech/v1/open-data:illumidesk/billing-invoices-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| limit | string | no | Limit when getting items. |
| offset | string | no | Offset when getting items. |
| ordering | string | no | Ordering when getting items. |

### Get an invoice
`GET https://apizie.tech/v1/open-data:illumidesk/billing-invoices-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| id | string | yes | Invoice unique identifier expressed as UUID. |

### Get invoice items for a given invoice.
`GET https://apizie.tech/v1/open-data:illumidesk/billing-invoice-items-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| invoice_id | string | yes | Invoice id, expressed as UUID. |
| limit | string | no | Limit when getting items. |
| offset | string | no | Offset when getting items. |
| ordering | string | no | Ordering when getting items. |

### Get a specific InvoiceItem.
`GET https://apizie.tech/v1/open-data:illumidesk/billing-invoice-items-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| invoice_id | string | yes | Invoice id, expressed as UUID. |
| id | string | yes | InvoiceItem id, expressed as UUID. |

### Get billing plans
`GET https://apizie.tech/v1/open-data:illumidesk/billing-plans-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| limit | string | no | Limit when getting items. |
| offset | string | no | Offset when getting items. |
| ordering | string | no | Ordering when getting items. |

### Get a billing plan
`GET https://apizie.tech/v1/open-data:illumidesk/billing-plans-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| id | string | yes | Plan unique identifier expressed as UUID. |

### Get active subscriptons
`GET https://apizie.tech/v1/open-data:illumidesk/billing-subscriptions-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| limit | string | no | Limit when getting items. |
| offset | string | no | Offset when getting items. |
| ordering | string | no | Ordering when getting items. |

### Create a new subscription
`POST https://apizie.tech/v1/open-data:illumidesk/billing-subscriptions-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| body | object | no | JSON request body |

### Get a subscriptions
`GET https://apizie.tech/v1/open-data:illumidesk/billing-subscriptions-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| id | string | yes | Unique identifier expressed as UUID. |

### Delete a subscription
`POST https://apizie.tech/v1/open-data:illumidesk/billing-subscriptions-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| id | string | yes | Subscription unique identifier expressed as UUID. |

### Get notifications of all types and entities for the authenticated user.
`GET https://apizie.tech/v1/open-data:illumidesk/notifications-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team data. |
| limit | string | no | Limit when getting items. |
| offset | string | no | Offset when getting items. |
| ordering | string | no | Ordering when getting items. |
| read | boolean | no | When true, get only read notifications. When false, get only unread notifications. Default behavior is to return both read and unread. |

### Mark a list of notifications as either read or unread.
`POST https://apizie.tech/v1/open-data:illumidesk/notifications-update-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| body | object | yes | JSON request body |

### Get notifications of all types and entities for the authenticated user.
`GET https://apizie.tech/v1/open-data:illumidesk/notifications-list-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team data. |
| limit | string | no | Limit when getting items. |
| offset | string | no | Offset when getting items. |
| ordering | string | no | Ordering when getting items. |
| entity | string | yes | Entity to filter notifications by. |
| read | boolean | no | When true, get only read notifications. When false, get only unread notifications. Default behavior is to return both read and unread. |

### Mark a list of notifications as either read or unread.
`POST https://apizie.tech/v1/open-data:illumidesk/notifications-update-entity-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| entity | string | yes | Entity to filter notifications by. |
| body | object | yes | JSON request body |

### Retrieve global notification settings for the authenticated user
`GET https://apizie.tech/v1/open-data:illumidesk/notification-settings-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team data. |

### Create global notification settings
`POST https://apizie.tech/v1/open-data:illumidesk/notification-settings-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| body | object | yes | JSON request body |

### Modify global notification settings.
`POST https://apizie.tech/v1/open-data:illumidesk/notification-settings-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| body | object | no | JSON request body |

### Retrieve global notification settings for the authenticated user
`GET https://apizie.tech/v1/open-data:illumidesk/notification-settings-entity-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team data. |
| entity | string | yes | Entity whose settings should be retrieved. |

### Create global notification settings
`POST https://apizie.tech/v1/open-data:illumidesk/notification-settings-entity-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| entity | string | yes | Entity whose settings should be retrieved. |
| body | object | no | JSON request body |

### Modify global notification settings.
`POST https://apizie.tech/v1/open-data:illumidesk/notification-settings-entity-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| entity | string | yes | Entity whose settings should be retrieved. |
| body | object | no | JSON request body |

### Retrieve a specific notification.
`GET https://apizie.tech/v1/open-data:illumidesk/notification-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team data. |
| notification_id | string | yes | Notification UUID. |

### Mark a specific notification as either read or unread.
`POST https://apizie.tech/v1/open-data:illumidesk/notification-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team data. |
| notification_id | string | yes | Notification UUID. |
| body | object | no | JSON request body |

### Retrieve oauth applications
`GET https://apizie.tech/v1/open-data:illumidesk/oauth-applications-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| limit | string | no | Set limit when retrieving items. |
| offset | string | no | Offset when retrieving items. |
| ordering | string | no | Set order when retrieving items. |

### Create a new OAuth2 application
`POST https://apizie.tech/v1/open-data:illumidesk/oauth-application-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| body | object | no | JSON request body |

### Get an application by id
`GET https://apizie.tech/v1/open-data:illumidesk/oauth-application-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| application | string | yes | Application unique identifier expressed as UUID or name. |

### Replace an application by id
`POST https://apizie.tech/v1/open-data:illumidesk/oauth-application-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| application | string | yes | Application unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Update an application by id
`POST https://apizie.tech/v1/open-data:illumidesk/oauth-application-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| application | string | yes | Application unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Delete an application by id
`POST https://apizie.tech/v1/open-data:illumidesk/oauth-application-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| application | string | yes | Application unique identifier expressed as UUID or name. |

### Get available projects
`GET https://apizie.tech/v1/open-data:illumidesk/projects-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| limit | string | no | Limit when getting data. |
| offset | string | no | Offset when getting data. |
| private | string | no | Private project or public project. |
| name | string | no | Project name. |
| ordering | string | no | Ordering when getting projects. |

### Create a new project
`POST https://apizie.tech/v1/open-data:illumidesk/projects-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| body | object | no | JSON request body |

### Copy a project to your own account.
`POST https://apizie.tech/v1/open-data:illumidesk/project-copy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| body | object | yes | JSON request body |

### Get a project
`GET https://apizie.tech/v1/open-data:illumidesk/projects-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| project | string | yes | Project unique identifier expressed as UUID or name. |

### Replace a project
`POST https://apizie.tech/v1/open-data:illumidesk/projects-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team namespace. |
| project | string | yes | Project unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Update a project
`POST https://apizie.tech/v1/open-data:illumidesk/projects-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| project | string | yes | Project unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Delete a project
`POST https://apizie.tech/v1/open-data:illumidesk/projects-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | yes | User or team name. |
| project | string | yes | Project unique identifier expressed as UUID or name. |

### Get project collaborators
`GET https://apizie.tech/v1/open-data:illumidesk/projects-collaborators-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| limit | string | no | Limit when retrieving items. |
| offset | string | no | Offset when retrieving items. |
| ordering | string | no | Ordering when retrieving items. |

### Create project collaborators
`POST https://apizie.tech/v1/open-data:illumidesk/projects-collaborators-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| body | object | no | JSON request body |

### Get a project collaborator
`GET https://apizie.tech/v1/open-data:illumidesk/projects-collaborators-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier. |
| namespace | string | yes | User or team name. |
| collaborator | string | yes | Collaborator unique identifier expressed as UUID or name. |

### Update project collaborator
`POST https://apizie.tech/v1/open-data:illumidesk/projects-collaborators-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes |  |
| namespace | string | yes | User or team name. |
| collaborator | string | yes |  |
| body | object | no | JSON request body |

### Delete a project collaborator
`POST https://apizie.tech/v1/open-data:illumidesk/projects-collaborators-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier. |
| namespace | string | yes | User or team name. |
| collaborator | string | yes | Collaborator unique identifier. |

### Retrieve deployments
`GET https://apizie.tech/v1/open-data:illumidesk/projects-deployments-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| limit | string | no | Limit results when getting deployment list. |
| offset | string | no | Offset results when getting deployment list. |
| name | string | no | Server name. |
| ordering | string | no | Ordering option when getting deployment list. |

### Create a new deployment
`POST https://apizie.tech/v1/open-data:illumidesk/projects-deployments-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifer expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| body | object | no | JSON request body |

### Retrieve a deployment
`GET https://apizie.tech/v1/open-data:illumidesk/projects-deployments-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| deployment | string | yes | Deployment unique identifier expressed as UUID or name. |

### Replace a deployment
`POST https://apizie.tech/v1/open-data:illumidesk/projects-deployments-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| deployment | string | yes | Deployment unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Update a deployment
`POST https://apizie.tech/v1/open-data:illumidesk/projects-deployments-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| deployment | string | yes | Deployment unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Delete a deployment
`POST https://apizie.tech/v1/open-data:illumidesk/projects-deployment-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier. |
| namespace | string | yes | User or team name. |
| deployment | string | yes | User unique identifier. |

### Deploy an existing model
`POST https://apizie.tech/v1/open-data:illumidesk/projects-deployments-deploy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| deployment | string | yes | Deployment unique identifier expressed as UUID or name. |

### Get project files
`GET https://apizie.tech/v1/open-data:illumidesk/projects-project-files-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Unique identifier for project file expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| limit | string | no | Limit when getting project file list. |
| offset | string | no | Offset when getting project file list. |
| ordering | string | no | Ordering of list values when getting project file list. |
| filename | string | no | Exact file name, relative to the project root. If no such file is found, an empty list will be returned. |
| content | string | no | Determines whether or not content is returned as base64. Defaults to false. |

### Create project files
`POST https://apizie.tech/v1/open-data:illumidesk/projects-project-files-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier. |
| namespace | string | yes | User or team name. |
| body | object | no | Form fields as a JSON object |

### Get a project file
`GET https://apizie.tech/v1/open-data:illumidesk/projects-project-files-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifer. |
| namespace | string | yes | User or team name. |
| id | string | yes | File unique identifier. |
| content | string | no | Determines whether or not content is returned as base64. Defaults to false. |

### Replace a project file
`POST https://apizie.tech/v1/open-data:illumidesk/projects-project-files-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifer. |
| namespace | string | yes | User or team name. |
| id | string | yes | File unique identifier. |
| body | object | no | Form fields as a JSON object |

### Update a project file
`POST https://apizie.tech/v1/open-data:illumidesk/projects-project-files-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifer. |
| namespace | string | yes | User or team name. |
| id | string | yes | File unique identifier. |
| body | object | no | Form fields as a JSON object |

### Delete a project file
`POST https://apizie.tech/v1/open-data:illumidesk/projects-project-files-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifer. |
| namespace | string | yes | User or team name. |
| id | string | yes | File unique identifier. |

### Retrieve servers
`GET https://apizie.tech/v1/open-data:illumidesk/projects-servers-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| limit | string | no | Limit results when getting server list. |
| offset | string | no | Offset results when getting server list. |
| name | string | no | Server name. |
| ordering | string | no | Ordering option when getting server list. |

### Create a new server
`POST https://apizie.tech/v1/open-data:illumidesk/projects-servers-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifer expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| body | object | no | JSON request body |

### Retrieve server statuses
`GET https://apizie.tech/v1/open-data:illumidesk/projects-servers-statuses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |

### Retrieve a server
`GET https://apizie.tech/v1/open-data:illumidesk/projects-servers-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| server | string | yes | Server unique identifier expressed as UUID or name. |

### Replace a server
`POST https://apizie.tech/v1/open-data:illumidesk/projects-servers-replace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| server | string | yes | Server unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Update a server
`POST https://apizie.tech/v1/open-data:illumidesk/projects-servers-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| server | string | yes | Server unique identifier expressed as UUID or name. |
| body | object | no | JSON request body |

### Delete a server
`POST https://apizie.tech/v1/open-data:illumidesk/projects-servers-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier. |
| namespace | string | yes | User or team name. |
| server | string | yes | User unique identifier. |

### Get server API key
`GET https://apizie.tech/v1/open-data:illumidesk/projects-servers-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| server | string | yes | Server unique identifier expressed as UUID or name. |

### Server api key validation
`POST https://apizie.tech/v1/open-data:illumidesk/projects-servers-auth` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| server | string | yes | Server unique identifier expressed as UUID or name. |

### Create a new server's run statistics
`POST https://apizie.tech/v1/open-data:illumidesk/projects-servers-run-stats-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| server | string | yes | Server unique identifier expressed as UUID or name. |
| project | string | yes | Project unique identifier expressed as UUID or name. |
| namespace | string | yes | User or team name. |
| body | object | no | JSON request body |

…and 23 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/open-data:illumidesk/auth-jwt-token-auth" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the IllumiDesk API?
Create a free Apizie key, then send POST https://apizie.tech/v1/open-data:illumidesk/auth-jwt-token-auth with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the IllumiDesk API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. IllumiDesk itself also needs your own key from illumidesk.com.

### Can AI agents use the IllumiDesk API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:illumidesk.

### What is the status of the IllumiDesk API?
Needs your own provider key (bring your own key)