> 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/api-quickstart.md).

# API quickstart

Create an API token and make your first Marketplace Platform API request.

Marketplace Platform REST APIs provide programmatic access to accounts, orders, subscriptions, billing, notifications, and other Marketplace resources.

Use this guide to create an API token and make your first API call.

{% stepper %}
{% step %}

### Before you start

Ensure that you have:

* Access to a Marketplace Platform account.
* Permission to create API tokens in the Marketplace.
* A tool for sending requests, such as Postman.
  {% endstep %}

{% step %}

### Generate an API token

Marketplace Platform APIs use API tokens for authentication.

To create a token:

1. [Sign in](https://portal.platform.softwareone.com/) to your Marketplace account.
2. Open the main menu, then go to **Settings** > **API tokens**.
3. Select **Add**.
4. Complete the **Add API token** workflow. For detailed instructions, see [Create API token](/modules-and-features/settings/api-tokens/create-api-token.md).
5. Copy the token value.
   {% endstep %}

{% step %}

### Make your first API request

Once you have your API token, send a request to one of the available endpoints. 

All Marketplace Platform API endpoints use the following base URL: 

```
https://api.platform.softwareone.com
```

The following example uses the [Accounts API](/developer-resources/rest-api/accounts-api.md) to retrieve a list of buyers in your account.

Send a `GET` request to the `/public/v1/accounts/buyers` endpoint:

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

{% endstep %}

{% step %}

### Review the response

If the request succeeds, the API returns a `200 OK` response and a list of buyers in the response body. 

{% code title="200 OK" overflow="wrap" lineNumbers="true" expandable="true" %}

```json
{
	"$meta": {
		"pagination": {
			"offset": 0,
			"limit": 10,
			"total": 1
		},
		"omitted": [
			"audit"
		]
	},
	"data": [
		{
			"id": "BUY-2844-0294",		
            "icon": "/buyers/BUY-2844-0294/icon",
			"contact": null,
			"externalIds": {
				"erpCompanyContact": "WW-CON-123456",
				"erpCustomer": "WW-SCU-123456"
			},
			"status": "Enabled",
			"icon": null,
			"address": {
				"addressLine1": "PO Box 31",
				"addressLine2": "Victory Road",
				"postCode": "DE24 8BJ",
				"city": "Derby",
				"state": "Derbs",
				"country": "UK"
	
	
					},
			"taxId": "VAT1",
			"account": {
				"id": "ACC-5563-4382",
				"href": "/accounts/ACC-5563-4382",
				"icon": null,
				"name": "Intelli Industries"
			},
			"name": "Rolls, Inc",
			"sellers": [
				{
					"id": "SEL-0578-5578",				
					"externalId": "SWO_CA",
					"name": "SoftwareOne Canada, Inc."
				}
			]
		}
	]
}
```

{% endcode %}

If the access token is invalid, the API returns  `401 Unauthorized`. 

If the token doesn't have permission to access the endpoint, the API returns `403 Forbidden`. Note that access to this endpoint depends on the account type associated with the token, rather than the enabled modules. The token must belong to a **client** or **ops** account. 

For more HTTP status codes, see [Error handling](/developer-resources/api-usage-and-reference/errors-handling.md).
{% endstep %}
{% endstepper %}

### Continue building with Marketplace Platform APIs

After successfully authenticating, you can use the same API token to access other Marketplace APIs. Choose a common integration scenario to continue building with the platform.

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><strong>Manage accounts and users</strong></td><td>Create and manage accounts, users, groups, and API tokens.</td><td><a href="/developer-resources/rest-api/accounts-api.md">Accounts API</a></td><td></td></tr><tr><td><strong>Manage orders and subscriptions</strong></td><td>Manage orders, subscriptions, assets, and agreements.</td><td><a href="/developer-resources/rest-api/commerce-api.md">Commerce API</a></td><td></td></tr><tr><td><strong>Access billing data</strong></td><td>Retrieve invoices, statements, charges, and billing information.</td><td><a href="/developer-resources/rest-api/billing-api.md">Billing API</a></td><td></td></tr><tr><td><strong>Manage products and catalogs</strong></td><td>Browse and manage products, catalogs, and related metadata.</td><td><a href="/developer-resources/rest-api/catalog-api.md">Catalog API</a></td><td></td></tr><tr><td><strong>Manage notifications</strong></td><td>Send notifications, manage recipients and categories, and track message delivery.</td><td><a href="/developer-resources/rest-api/notifications-api.md">Notifications API</a></td><td></td></tr></tbody></table>

{% hint style="info" %}
Looking for additional APIs or guidance? See [Browse APIs](/developer-resources/rest-api.md#browse-apis) and [API Usage & Reference](/developer-resources/api-usage-and-reference.md).
{% endhint %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.