# Onna Platform API API

> Onna Platform API API on Apizie: 27 endpoints (List Custom Fields, Create Custom Field, Create Folder, Retrieve Folder Info, …) 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/business:onna/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:onna`
- Category: Business
- Status: byok
- Source: https://onna.com
- Page: https://apizie.tech/api/business/onna
- OpenAPI: https://apizie.tech/api/business/onna/openapi.json

# Introduction ![Onna](https://onna.com/wp-content/uploads/2022/02/graphic-solutions-kip-kd.png "Diagram showing how Onna connects to various applications") The Onna Platform API enables you to programmatically upload…

## Endpoints

### List Custom Fields
`GET https://apizie.tech/v1/business:onna/custom-fields-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination) |

### Create Custom Field
`POST https://apizie.tech/v1/business:onna/custom-fields-create-field` (byok)

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

### Create Folder
`POST https://apizie.tech/v1/business:onna/folders-create-new-folder` (byok)

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

### Retrieve Folder Info
`GET https://apizie.tech/v1/business:onna/folders-get-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the folder. |

### Update Folder
`POST https://apizie.tech/v1/business:onna/folders-update-folder-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the folder. |
| body | object | yes | JSON request body |

### Delete Folder
`POST https://apizie.tech/v1/business:onna/folders-delete-folder` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the folder. |

### Health Check
`GET https://apizie.tech/v1/business:onna/utils-check-service-status` (byok)

### Login
`POST https://apizie.tech/v1/business:onna/authentication-exchange-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Current User
`GET https://apizie.tech/v1/business:onna/authentication-current-user-info` (byok)

### Create File
`POST https://apizie.tech/v1/business:onna/resources-files-create-new-file` (byok)

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

### Read File
`GET https://apizie.tech/v1/business:onna/resources-files-get-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the file. |

### Delete File
`POST https://apizie.tech/v1/business:onna/resources-files-delete-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the file. |

### Create Ticket
`POST https://apizie.tech/v1/business:onna/resources-tickets-create-new-ticket` (byok)

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

### Read Ticket
`GET https://apizie.tech/v1/business:onna/resources-tickets-get-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the ticket. |

### Delete Ticket
`POST https://apizie.tech/v1/business:onna/resources-tickets-remove-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the ticket. |

### Create Resource File Resumable Upload
`POST https://apizie.tech/v1/business:onna/upload-resource-file-resumable-upload` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| upload-defer-length | string | no | The `Upload-Defer-Length` request and response header indicates that the size of the upload is not known currently and will be transferred… |
| upload-length | string | no | The `Upload-Length` request and response header indicates the size of the entire upload in bytes. The value MUST be a non-negative… |
| upload-metadata | string | no | The `Upload-Metadata` request and response header MUST consist of one or more comma-separated key-value pairs. The key and value MUST be… |
| tus-resumable | string | no | The `Tus-Resumable` header is included in every request and response. ```bash Tus-Resumable: 1.0.0 ``` For more information on the headers… |

### Create Resource File Single Request
`POST https://apizie.tech/v1/business:onna/upload-resource-single-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Resume Resource File Upload
`POST https://apizie.tech/v1/business:onna/upload-resume-resource-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| content-length | string | no | The `Content-Length` header indicates the size of the message body, in bytes, sent to the recipient. ```bash Content-Length: 512 ``` For… |
| upload-offset | string | no | The `Upload-Offset` request and response header indicates a byte offset within a resource. The value MUST be a non-negative integer.… |
| tus-resumable | string | no | The `Tus-Resumable` header is included in every request and response. ```bash Tus-Resumable: 1.0.0 ``` For more information on the headers… |

### List Workspaces
`GET https://apizie.tech/v1/business:onna/workspaces-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| cursor | string | no | The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination) |

### Create Workspace
`POST https://apizie.tech/v1/business:onna/workspaces-create` (byok)

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

### Retrieve Workspace Info
`GET https://apizie.tech/v1/business:onna/workspaces-get-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the workspace. |

### Update Workspace
`POST https://apizie.tech/v1/business:onna/workspaces-update-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the workspace. |
| body | object | yes | JSON request body |

### Delete Workspace
`POST https://apizie.tech/v1/business:onna/workspaces-remove-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the workspace. |

### List Workspace Custom Fields
`GET https://apizie.tech/v1/business:onna/workspaces-list-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the workspace. |
| cursor | string | no | The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination) |

### Enable Workspace Custom Field
`POST https://apizie.tech/v1/business:onna/workspaces-enable-custom-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the workspace. |
| body | object | yes | JSON request body |

### Read Workspace Custom Value
`GET https://apizie.tech/v1/business:onna/workspaces-read-custom-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the workspace. |
| field_id | string | yes | Unique ID of the field. |

### Update Workspace Custom Value
`POST https://apizie.tech/v1/business:onna/workspaces-update-custom-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| onna_id | string | yes | Unique ID of the workspace. |
| field_id | string | yes | Unique ID of the field. |
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/business:onna/custom-fields-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Onna Platform API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/business:onna/custom-fields-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Onna Platform API 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 business:onna.

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