Send your Orbit API token in the Authorization header as Bearer <token>.
This reference covers requests with an existing token. The Orbit API specification declares bearer authentication as its default security requirement.
Request header
| Part | Value |
|---|---|
| Header name | Authorization |
| Authentication scheme | Bearer |
| Credential | Your Orbit API token, after one space |
Keep the token private. The text <token> is a placeholder, not a credential.
Example request
Set the shell variable ORBIT_API_TOKEN to your existing token before you run this example:
curl 'https://api.orbitapps.io/api/v1/apps' \
-H "Authorization: Bearer $ORBIT_API_TOKEN"The shell replaces $ORBIT_API_TOKEN with the variable's value. The double quotes allow that replacement.
A successful request returns HTTP 200 with a data array. For an example app named Team tasks, find the array entry with that title.
An empty successful response has this shape:
{"data": []}Read List apps for the organization filter and each returned field.
Token access affects the result
For the list-apps request:
- A profile-scoped token can list apps across organizations where the caller has an active membership.
- An organization-scoped token lists apps only within its bound organization.
- An
org_idfilter for an organization the caller cannot access returns an emptydataarray, not HTTP403.
An empty app list does not prove that authentication failed. Check the token's organization access and any org_id filter before you conclude that an app is absent.
Scope of this reference
This page describes the request header, not token creation, renewal, or revocation. It does not describe Google sign-in for people who use your app.
Read Apps for the relationship between apps and organizations.