> For the complete documentation index, see [llms.txt](https://docs.platform.softwareone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.platform.softwareone.com/developer-resources/rest-api.md).

# REST API

The Marketplace Platform REST API allows you to interact with the platform programmatically. 

The APIs are organized around REST principles, use predictable resource-oriented URLs, [JSON-encoded](http://www.json.org/) representations, and standard HTTP methods and status codes.

Each API works similarly, whether you access it directly over HTTP or through helper libraries in various programming languages.

### Common use cases

Use Marketplace APIs to:

* Manage accounts, users, and groups.
* Automate order processing and fulfillment workflows.
* Manage orders, subscriptions, and assets.
* Retrieve billing and financial data.
* Synchronize Marketplace data with external business systems.
* Integrate and manage notification workflows.

### Getting started

Follow [API Quickstart](/developer-resources/api-quickstart.md) to generate an API token, authenticate requests, and make your first API call.

### Authentication

Marketplace Platform uses [API tokens](/modules-and-features/settings/api-tokens.md) for authentication.

Include your API token in the `Authorization` HTTP header with the `Bearer` scheme. 

Your API keys have permissions assigned to them, so keep them secure. Don't share your secret API keys in public areas, like GitHub or client-side code.

### HTTPS requirements

All API requests must be made over HTTPS. 

Requests sent over HTTP are not supported. API requests without authentication will fail.

### Content-type requirements

Most Marketplace API endpoints expect requests to use the `application/json` content type. Endpoints that support file uploads may require `multipart/form-data` instead.

```http
GET https://api.platform.softwareone.com/public/v1/accounts/buyers
Authorization: Bearer {TOKEN_VALUE}
Content-Type: application/json
```

To communicate successfully with the APIs, ensure your API requests are formatted using the `application/json` content type. 

Using the wrong content type may result in unexpected behavior or errors.

### Browse APIs

<table data-search="false"><thead><tr><th width="225">API</th><th>Description</th><th data-hidden data-type="content-ref"></th></tr></thead><tbody><tr><td><a href="/developer-resources/rest-api/accounts-api.md">Accounts API</a></td><td>Manage accounts, users, groups, &#x26; more. </td><td><a href="/developer-resources/rest-api/accounts-api.md">Accounts API</a></td></tr><tr><td><a href="/developer-resources/rest-api/audit-api.md">Audit API</a></td><td>Track and retrieve audit activity.</td><td><a href="/developer-resources/rest-api/audit-api.md">Audit API</a></td></tr><tr><td><a href="/developer-resources/rest-api/billing-api.md">Billing API</a></td><td>Work with invoices, statements, charges, &#x26; more.</td><td><a href="/developer-resources/rest-api/billing-api.md">Billing API</a></td></tr><tr><td><a href="/developer-resources/rest-api/catalog-api.md">Catalog API</a></td><td>Manage catalog, products, items, &#x26; more.</td><td><a href="/developer-resources/rest-api/catalog-api.md">Catalog API</a></td></tr><tr><td><a href="/developer-resources/rest-api/commerce-api.md">Commerce API</a></td><td>Manage orders, subscriptions, assets, &#x26; more.</td><td><a href="/developer-resources/rest-api/commerce-api.md">Commerce API</a></td></tr><tr><td><a href="/developer-resources/rest-api/currency-api.md">Currency API</a></td><td>Work with currencies, pairs, and exchange rates.</td><td><a href="/developer-resources/rest-api/currency-api.md">Currency API</a></td></tr><tr><td><a href="/developer-resources/rest-api/extensions-api.md">Extensions API</a></td><td>Manage extensions, installations, media, &#x26; more.</td><td><a href="/developer-resources/rest-api/extensions-api.md">Extensions API</a></td></tr><tr><td><a href="/developer-resources/rest-api/helpdesk-api.md">Helpdesk API</a></td><td>Manage cases, chats, feedback, &#x26; more.</td><td><a href="/developer-resources/rest-api/helpdesk-api.md">Helpdesk API</a></td></tr><tr><td><a href="/developer-resources/rest-api/notifications-api.md">Notifications API</a></td><td>Manage notifications, subscribers, &#x26; more.</td><td><a href="/developer-resources/rest-api/notifications-api.md">Notifications API</a></td></tr><tr><td><a href="/developer-resources/rest-api/product-catalog-api.md">Product Catalog API</a></td><td>Browse software products, manage profile, categories, &#x26; more.</td><td><a href="/developer-resources/rest-api/product-catalog-api.md">Product Catalog API</a></td></tr><tr><td><a href="/developer-resources/rest-api/program-api.md">Program API</a></td><td>Manage programs, enrollments, and certificates.</td><td><a href="/developer-resources/rest-api/program-api.md">Program API</a></td></tr><tr><td><a href="/developer-resources/rest-api/spotlight-objects-api.md">Spotlight API</a></td><td>Work with spotlight objects and queries.</td><td><a href="/developer-resources/rest-api/spotlight-objects-api.md">Spotlight API</a></td></tr><tr><td><a href="/developer-resources/rest-api/task-api.md">Task API</a></td><td>Create tasks and retrieve task logs and results.</td><td><a href="/developer-resources/rest-api/task-api.md">Task API</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.platform.softwareone.com/developer-resources/rest-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.