Orbit

Orbit API

Please see the complete Orbit API documentation at [https://api.orbit.love/](https://api.orbit.love/).

Other#openapi#customer-relation

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Please see the complete Orbit API documentation at https://api.orbit.love/.

Endpoints 33

Activity Types

  • GETList all activity types for a workspace/:workspace_slug/activity_types

Activities

  • GETList activities for a workspace/:workspace_slug/activities?affiliation=member&member_tags=string&orbit=string&activity_type=discourse:topic:created&identity=github&company[]=string&title[]=string&regions[]=string&countries[]=string&cities[]=string&start_date=string&end_date=string&relative=string&page=string&direction=ASC&items=10&sort=occurred_at&type=string
  • POSTCreate a Custom or a Content activity for a new or existing member/:workspace_slug/activitiesUse this method when you know an identity of the member (github, email, twitter, etc.) but not their Orbit ID. Pass fields in the member object to update the…
  • GETGet an activity in the workspace/:workspace_slug/activities/:id
  • GETList activities for a member/:workspace_slug/members/:member_slug/activities?page=string&direction=ASC&items=10&sort=occurred_at&activity_type=string&type=string
  • POSTCreate a Custom or a Content activity for a member/:workspace_slug/members/:member_slug/activities
  • PUTUpdate a custom activity for a member/:workspace_slug/members/:member_slug/activities/:id
  • DELETEDelete a post activity/:workspace_slug/members/:member_slug/activities/:id
  • GETList member activities in an organization/:workspace_slug/organizations/:organization_id/activities?page=string&direction=ASC&items=10&sort=occurred_at&activity_type=content

Webhooks

  • GETList webhooks in a workspace/:workspace_slug/webhooks
  • POSTCreate a webhook/:workspace_slug/webhooks
  • GETGet a webhook/:workspace_slug/webhooks/:id
  • PUTUpdate a webhook/:workspace_slug/webhooks/:id
  • DELETEDelete a webhook/:workspace_slug/webhooks/:id

Members

  • GETList members in a workspace/:workspace_slug/members?affiliation=member&member_tags=string&orbit=string&activity_type=discourse:topic:created&identity=github&company[]=string&title[]=string&regions[]=string&countries[]=string&cities[]=string&start_date=string&end_date=string&relative=string&query=string&page=string&direction=ASC&items=10&activities_count_min=string&activities_count_max=string&sort=activities_count&type=string
  • POSTCreate or update a member/:workspace_slug/membersThis method is useful when you know a member's identity in another system and want to create or update the corresponding Orbit member. Identities can be…
  • GETFind a member by an identity/:workspace_slug/members/find?source=string&source_host=string&uid=string&username=string&email=string&github=stringProvide a source and one of username/uid/email params to return a member with that identity, if one exists. Common values for source include github, twitter,…
  • GETGet a member/:workspace_slug/members/:member_slug
  • PUTUpdate a member/:workspace_slug/members/:member_slug
  • DELETEDelete a member/:workspace_slug/members/:member_slug
  • POSTAdd identity to a member/:workspace_slug/members/:member_slug/identities
  • DELETERemove identity from a member/:workspace_slug/members/:member_slug/identities
  • GETList members in an organization/:workspace_slug/organizations/:organization_id/members?page=string&items=10

Notes

  • GETGet the member's notes/:workspace_slug/members/:member_slug/notes?page=string
  • POSTCreate a note/:workspace_slug/members/:member_slug/notes
  • PUTUpdate a note/:workspace_slug/members/:member_slug/notes/:id

Organizations

  • GETList organizations in a workspace/:workspace_slug/organizations?query=string&page=string&direction=ASC&items=10&sort=name
  • GETGet an organization/:workspace_slug/organizations/:organization_id
  • PUTUpdate an organization/:workspace_slug/organizations/:organization_id

Reports

  • GETGet a workspace stats/:workspace_slug/reports?start_date=string&end_date=string&relative=string&properties=string&activity_type=string&type=string

Users

  • GETGet info about the current user/user

Workspaces

  • GETGet all workspaces for the current user/workspaces
  • GETGet a workspace/workspaces/:workspace_slug?include_orbit_level_counts=true

API details

Base URL
https://app.orbit.love/api/v1
Authentication
An API key in the api_key query parameter
A bearer token in the Authorization header
Operations
33 operations on 21 pathsGET 18POST 6PUT 5DELETE 4
Main resources
Members 9Activities 8Webhooks 5Notes 3Organizations 3Workspaces 2Activity Types 1Reports 1Users 1
Response formats
application/json
Description format
OpenAPI 3.0.1, API version v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Orbit API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Orbit API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the api_key query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List all activity types for a workspace” (GET /:workspace_slug/activity_types), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Orbit API?

Please see the complete Orbit API documentation at [https://api.orbit.love/](https://api.orbit.love/). It is listed under Other and has 33 endpoints.

Who publishes the Orbit API?

It is listed from Orbit's public API description (an OpenAPI document), not published by Orbit on Swastik Codes. Anyone who controls orbit.love can claim the profile by adding a DNS TXT record.

What is the base URL of the Orbit API?

Requests go to https://app.orbit.love/api/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Orbit API?

It accepts 2 methods: an API key in the api_key query parameter; A bearer token in the Authorization header.

How many endpoints does the Orbit API have?

33 operations on 21 paths (18 GET, 6 POST, 5 PUT, 4 DELETE). The largest groups are Members, Activities, Webhooks, Notes.

Is forking the Orbit API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.