Use an HTTP client to send a bearer-authenticated request to the Orbit platform API and read the apps your token can access.
This guide uses a client that lets you set an HTTP method, URL, and request headers. The steps do not depend on one client's button names. This is the platform API, not a generated app's own API.
Before you start
You need an existing Orbit API token and an HTTP client. This guide does not create a token. Keep the token private, including in saved requests and exported client collections.
The Orbit API specification defines the request used below. For this example, suppose you want to find an existing app named Team tasks.
Configure the request
- Create a request in your HTTP client.
- Set the method to
GET. - Set the URL to
https://api.orbitapps.io/api/v1/apps. - Add a request header named
Authorization. - Set its value to
Bearer <token>. Replace<token>with your existing token, without the angle brackets.
The header has this shape:
Authorization: Bearer <token>Leave the request body empty. The list-apps operation does not define a request body.
If your client has a bearer-token authentication option, you can use that option instead of a manual header. Check that the client sends one Authorization header with the format above.
Send and check the response
- Send the request.
- Check the HTTP response code. The documented successful response is
200. - Open the JSON response body.
- Find the
dataarray.
If the token can read Team tasks, find the app object whose title matches that name. Copy its id when another operation requires the app UUID. Do not use the title or slug in place of that UUID.
An empty successful response looks like this:
{"data": []}An empty array does not prove that the token failed authentication. A profile-scoped token lists apps across active organization memberships. An organization-scoped token lists apps within its bound organization.
To restrict the request to one organization, add the optional query parameter org_id with that organization's UUID. An organization the caller cannot access returns an empty array, not HTTP 403.
Read List apps for the response fields and organization filter.
If the request does not work
Compare the method, URL, and outgoing header with the values above. Confirm that the header contains the token value, not the literal text <token>.
If the response is not 200, inspect the response body before you change the request. This guide does not assign one error code to every authentication or access failure. Read API bearer authentication for the documented header and access rules.
Before you send a different request, check that operation in the specification. Do not reuse this operation's empty body or response format without checking. The REST API overview describes the platform API's scope.