The Orbit platform REST API lets clients work with Orbit resources, including organizations, apps, deployments, and workspaces.

Use this API to work with Orbit projects. This reference does not describe a generated app's own API.

## API address and specification

The examples in these docs use `https://api.orbitapps.io` with paths under `/api/v1`.

The [Orbit API specification](https://api.orbitapps.io/openapi.json) defines operations, parameters, request bodies, response schemas, and security requirements. Check the operation you plan to call rather than assume that every operation accepts the same parameters.

## Authentication

The specification declares bearer authentication as the default security requirement. Send an existing API token in the `Authorization` header:

```text
Authorization: Bearer <token>
```

Replace `<token>` with your token. Keep the token private. Read [API bearer authentication](/reference/api-authentication) for the header format and token access rules.

## A first read-only request

The list-apps operation returns apps your token can read. Set the shell variable `ORBIT_API_TOKEN` to your existing token before you run this example:

```sh
curl 'https://api.orbitapps.io/api/v1/apps' \
  -H "Authorization: Bearer $ORBIT_API_TOKEN"
```

A successful response uses HTTP `200` and contains a JSON object with a `data` array. An empty result looks like this:

```json
{"data": []}
```

For an example app named `Team tasks`, find the object whose `title` matches that name. Its `id` is the app UUID for later requests. Do not substitute the title or slug for that UUID.

Read [List apps](/reference/apps) for the optional organization filter and every response field.

## Access and empty results

A profile-scoped token can list apps across organizations where the caller has an active membership. An organization-scoped token lists apps within its bound organization.

For the list-apps operation, an inaccessible `org_id` filter returns an empty `data` array rather than HTTP `403`. An empty list does not prove that authentication failed or that the organization has no apps.

## Choose the next operation

Use the specification to find the operation for your resource. Read its request requirements and documented responses before you call it.

The list-apps response format and access rules above apply to that operation. Do not assume that other operations use the same response envelope or error codes.

Read [Apps](/concepts/apps) for the relationship between apps and organizations.