The Activities API from Orbit — 5 operation(s) for activities.
openapi: 3.0.1
info:
title: Orbit Activities API
version: v1
description: Please see the complete Orbit API documentation at [https://api.orbit.love/](https://api.orbit.love/).
servers:
- url: http://web.archive.org/web/20240303060821/https://app.orbit.love/api/v1
tags:
- name: Activities
paths:
/{workspace_slug}/activities:
get:
summary: List activities for a workspace
tags:
- Activities
security:
- bearer: []
parameters:
- name: workspace_slug
in: path
required: true
schema:
type: string
- name: affiliation
in: query
schema:
type: string
enum:
- member
- teammate
- name: member_tags
in: query
description: The list of tags to filter against. Separate tags with `,` to do an intersection (AND), or with `|` to do a union (OR)
schema:
type: string
- name: orbit
in: query
description: The list of orbit levels to filter against. Accepted values are 1, 2, 3, 4, n. In the request, a format like `23` would include levels 2 and 3. `n` is for members with no orbit level.
schema:
type: string
- name: activity_type
in: query
schema:
type: string
enum:
- issue_comment:created
- pull_requests:opened
- pull_requests:merged
- fork:created
- star:created
- discussions:discussion_created
- discussions:comment
- discussions:reply
- discord:message:sent
- tweet:sent
- twitter:followed
- discord:thread:replied
- discord:message:replied
- discord:server:joined
- discourse:topic:created
- discourse:post:created
- discourse:post:liked
- discourse:user:created
- discord:forum:post_created
- slack:message:sent
- slack:thread:replied
- slack:channel:joined
- custom:happened
- dev:comment
- dev:followed
- insided:article:created
- insided:article:replied
- insided:conversation:started
- insided:conversation:replied
- insided:idea:replied
- insided:question:asked
- insided:idea:submitted
- linkedin:comment
- reddit:comment
- insided:question:replied
- reddit:post
- stackoverflow:answer
- stackoverflow:question
- youtube:comment
- note:created
- post:created
- issues:opened
description: Comma separated list of activity types
- name: identity
in: query
schema:
type: string
enum:
- github
- twitter
- email
- discourse
- linkedin
- devto
- slack
- discord
- name: company[]
in: query
description: Comma separated list of companies. The union (OR) of companies is applied.
schema:
type: string
- name: title[]
in: query
description: Comma separated list of job titles. The union (OR) of job titles is applied.
schema:
type: string
- name: regions[]
in: query
description: Comma separated list of regions. The union (OR) of regions is applied.
schema:
type: string
- name: countries[]
in: query
description: Comma separated list of countries. The union (OR) of countries is applied.
schema:
type: string
- name: cities[]
in: query
description: Comma separated list of cities. The union (OR) of cities is applied.
schema:
type: string
- name: start_date
in: query
description: 'Filter activities after this date. Format: YYYY-MM-DD.'
schema:
type: string
- name: end_date
in: query
description: 'Filter activities before this date. Format: YYYY-MM-DD.'
schema:
type: string
- name: relative
in: query
description: 'Relative timeframes. Format: this_<integer>_<period>, with period in [days, weeks, months, years]. For example, this_30_days.'
schema:
type: string
- name: page
in: query
schema:
type: string
- name: direction
in: query
schema:
type: string
enum:
- ASC
- DESC
- name: items
in: query
schema:
type: string
enum:
- '10'
- '50'
- '100'
- name: sort
in: query
schema:
type: string
enum:
- occurred_at
- member
- name: type
in: query
deprecated: true
description: Deprecated in favor of the activity_type parameter.
schema:
type: string
responses:
'200':
description: success
content:
application/json:
example:
data:
- id: 63rsLp
type: issue_activity
attributes:
action: opened
created_at: '2023-06-21T14:54:04.584Z'
key: wayne/collene#55
occurred_at: '2023-06-21T14:54:04.579Z'
updated_at: '2023-06-21T14:54:04.584Z'
type: IssueActivity
properties:
github_issue: wayne/collene/#55
github_repository: wayne/collene
github_organization: wayne
tags:
- channel:github
- github_organization:wayne
- github_repository:wayne/collene
- github_issue:wayne/collene/#55
orbit_url: http://web.archive.org/web/20240303060821/http://localhost:3000/avelinawiza/activities/63rsLp
weight: '1.0'
activity_link: http://web.archive.org/web/20240303060821/https://github.com/
g_title: Cool issue title!
g_number: 55
g_html_url: http://web.archive.org/web/20240303060821/https://github.com/
g_created_at: '2023-06-21T15:54:04.579+01:00'
is_pull_request: null
relationships:
activity_type:
data:
id: la4sVD
type: activity_type
member:
data:
id: By3S5j
type: member
repository:
data:
id: jP8TMj
type: repository
- id: V5YsvV
type: pull_request_activity
attributes:
action: opened
created_at: '2023-06-21T14:54:04.524Z'
key: jason/hermine#72
occurred_at: '2023-06-21T14:54:04.508Z'
updated_at: '2023-06-21T14:54:04.524Z'
type: PullRequestActivity
properties:
github_repository: jason/hermine
github_organization: jason
github_pull_request: jason/hermine/#72
tags:
- channel:github
- github_organization:jason
- github_repository:jason/hermine
- github_pull_request:jason/hermine/#72
orbit_url: http://web.archive.org/web/20240303060821/http://localhost:3000/avelinawiza/activities/V5YsvV
weight: '1.0'
activity_link: http://web.archive.org/web/20240303060821/https://github.com/
g_title: Cool PR title!
g_number: 72
g_html_url: http://web.archive.org/web/20240303060821/https://github.com/
g_created_at: '2023-06-21T15:54:04.508+01:00'
is_pull_request: null
g_merged: true
g_merged_at: null
g_merged_by: null
relationships:
activity_type:
data:
id: lnrs0l
type: activity_type
member:
data:
id: By3S5j
type: member
repository:
data:
id: 6l3Tz9
type: repository
- id: 6a4sBp
type: spec_activity
attributes:
action: spec_action
created_at: '2023-06-21T14:54:04.438Z'
key: clé
occurred_at: '2023-06-21T14:54:04.437Z'
updated_at: '2023-06-21T14:54:04.438Z'
type: SpecActivity
properties:
prop_1: value_1
prop_2: value_2
tags:
- spec-tag-1
- spec-tag-2
orbit_url: http://web.archive.org/web/20240303060821/http://localhost:3000/avelinawiza/activities/6a4sBp
weight: '1.0'
relationships:
activity_type:
data:
id: D2Esq5
type: activity_type
member:
data:
id: By3S5j
type: member
repository:
data:
id: jBlTg9
type: repository
included:
- id: la4sVD
type: activity_type
attributes:
name: Opened an issue
short_name: Issue opened
key: issues:opened
channel: github
source: github
weight: '6.0'
- id: By3S5j
type: member
attributes:
avatar_url: http://web.archive.org/web/20240303060821/http://github.com/avatar.png
bio: null
birthday: null
company: null
title: null
created_at: '2023-06-21T14:54:04.391Z'
deleted_at: null
location: null
name: JolineLang
pronouns: null
reach: 0
shipping_address: null
slug: jolinelang
source: installation
tag_list:
- ruby
tags:
- ruby
teammate: false
tshirt: null
updated_at: '2023-06-21T14:54:04.391Z'
merged_at: null
url: null
orbit_url: http://web.archive.org/web/20240303060821/http://localhost:3000/avelinawiza/members/jolinelang
created: false
id: By3S5j
orbit_level: null
love: null
first_activity_occurred_at: null
last_activity_occurred_at: null
activities_count: 0
activities_score: 0
twitter: null
github: null
discourse: null
email: null
devto: null
linkedin: null
discord: null
github_followers: null
twitter_followers: null
topics: null
languages: null
relationships:
identities:
data: []
organizations:
data: []
- id: jP8TMj
type: repository
attributes:
owner: see
name: tyrell
full_name: see/tyrell
updated_at: '2023-06-21T14:54:04.577Z'
created_at: '2023-06-21T14:54:04.577Z'
- id: lnrs0l
type: activity_type
attributes:
name: persuade Mysource 3
short_name: Spec Channel
key: spec:happened:1
channel: mysource
source: mysource
weight: '1.0'
- id: 6l3Tz9
type: repository
attributes:
owner: andreasbernier
name: timmybatz
full_name: andreasbernier/timmybatz
updated_at: '2023-06-21T14:54:04.496Z'
created_at: '2023-06-21T14:54:04.496Z'
- id: D2Esq5
type: activity_type
attributes:
name: qualify Mysource 2
short_name: Spec Channel
key: spec_activity_type_key
channel: mysource
source: mysource
weight: '1.0'
- id: jBlTg9
type: repository
attributes:
owner: randolph
name: bruna
full_name: orbit-love/orbit-model
updated_at: '2023-06-21T14:54:04.419Z'
created_at: '2023-06-21T14:54:04.419Z'
links:
first: http://web.archive.org/web/20240303060821/http://localhost:3000/api/v1/avelinawiza/activities?activity_type=&affiliation=&cities%5B%5D=&company%5B%5D=&countries%5B%5D=&direction=DESC&end_date=&filters=true&identity=&items=10&member_tags=&orbit=&page=1®ions%5B%5D=&relative=&sort=occurred_at&start_date=&title%5B%5D=&workspace=avelinawiza
prev: null
next: null
post:
summary: Create a Custom or a Content activity for a new or existing member
tags:
- Activities
description: Use 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 member in addition to creating the activity.
security:
- bearer: []
parameters:
- name: workspace_slug
in: path
required: true
schema:
type: string
responses:
'422':
description: unprocessable
content:
application/json:
example:
errors:
base:
- Either identity or member name, email, GitHub, Twitter or Discourse is required
'201':
description: success
content:
application/json:
example:
data:
id: 6zoslV
type: custom_activity
attributes:
action: happened
created_at: '2023-06-21T14:54:08.263Z'
key: thing-123
occurred_at: '2023-06-21T14:54:08.255Z'
updated_at: '2023-06-21T14:54:08.263Z'
type: CustomActivity
properties: {}
tags:
- product
- enterprise
- channel:custom
- custom_type:custom-type
- custom_title:did-a-thing
orbit_url: http://web.archive.org/web/20240303060821/http://localhost:3000/mscalandrabrekke/activities/6zoslV
weight: '0.2'
custom_description: More info about the thing
custom_link: http://web.archive.org/web/20240303060821/http://link.com/
custom_link_text: See the thing
custom_title: Did a thing
custom_type: custom-type
custom_context: null
body: More info about the thing
relationships:
activity_type:
data:
id: 574seD
type: activity_type
member:
data:
id: r9nS0B
type: member
user:
data:
id: DXKFEz
type: user
included:
- id: 574seD
type: activity_type
attributes:
name: Something happened
short_name: Custom
key: custom:happened
channel: custom
source: custom
weight: '1.0'
- id: 3YETv3
type: twitter_identity
attributes:
uid: '45297280'
email: null
username: dzello
name: Josh Dzielak
source: twitter
source_host: twitter.com
profile_url: http://web.archive.org/web/20240303060821/https://twitter.com/dzello
url: null
- id: r9nS0B
type: member
attributes:
avatar_url: http://web.archive.org/web/20240303060821/https://abs.twimg.com/sticky/default_profile_images/default_profile.png
bio: <a href='http://web.archive.org/web/20240303060821/https://dzello.com/blog/2020/05/30/black-lives-matter/' target='_blank'>dzello.com/blog/2020/05/3…</a> Co-founder & CTO @OrbitModel · advocate for dev advocates 🥑 · formerly @algolia and @keen_io · Ruby · Rails · JAMstack · he/him
birthday: null
company: null
title: null
created_at: '2023-06-21T14:54:08.167Z'
deleted_at: null
location: Paris, France
name: Josh Dzielak
pronouns: null
reach: 1
shipping_address: null
slug: dzello
source: api
tag_list:
- one
- two
tags:
- one
- two
teammate: false
tshirt: null
updated_at: '2023-06-21T14:54:08.191Z'
merged_at: null
url: http://web.archive.org/web/20240303060821/https://dzello.com/blog/2020/05/30/black-lives-matter/
orbit_url: http://web.archive.org/web/20240303060821/http://localhost:3000/mscalandrabrekke/members/dzello
created: true
id: r9nS0B
orbit_level: null
love: null
first_activity_occurred_at: null
last_activity_occurred_at: null
activities_count: 0
activities_score: 0
twitter: dzello
github: null
discourse: null
email: null
devto: null
linkedin: null
discord: null
github_followers: null
twitter_followers: 9
topics: null
languages: null
relationships:
identities:
data:
- id: 3YETv3
type: twitter_identity
organizations:
data: []
- id: DXKFEz
type: user
attributes:
name: DiedreHettinger
updated_at: '2023-06-21T14:54:08.087Z'
created_at: '2023-06-21T14:54:08.081Z'
'403':
description: forbidden
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/activity_and_identity'
/{workspace_slug}/activities/{id}:
get:
summary: Get an activity in the workspace
tags:
- Activities
security:
- bearer: []
parameters:
- name: workspace_slug
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: success
content:
application/json:
example:
data:
id: ZPosjV
type: spec_activity
attributes:
action: spec_action
created_at: '2023-06-21T14:54:07.274Z'
key: clé
occurred_at: '2023-06-21T14:54:07.264Z'
updated_at: '2023-06-21T14:54:07.274Z'
type: SpecActivity
properties:
prop_1: value_1
prop_2: value_2
tags:
- spec-tag-1
- spec-tag-2
orbit_url: http://web.archive.org/web/20240303060821/http://localhost:3000/markitasauer/activities/ZPosjV
weight: '1.0'
relationships:
activity_type:
data:
id: D3jsky
type: activity_type
member:
data:
id: rmMSRr
type: member
repository:
data:
id: 9ABTo6
type: repository
user:
data:
id: OA3F51
type: user
included:
- id: D3jsky
type: activity_type
attributes:
name: take Mysource 29
short_name: Spec Channel
key: spec:happened:9
channel: mysource
source: mysource
weight: '1.0'
- id: rmMSRr
type: member
attributes:
avatar_url: http://web.archive.org/web/20240303060821/http://github.com/avatar.png
bio: null
birthday: null
company: null
title: null
created_at: '2023-06-21T14:54:07.270Z'
deleted_at: null
location: null
name: AudieDare
pronouns: null
reach: 0
shipping_address: null
slug: audiedare
source: installation
tag_list: []
tags: []
teammate: false
tshirt: null
updated_at: '2023-06-21T14:54:07.270Z'
merged_at: null
url: null
orbit_url: http://web.archive.org/web/20240303060821/http://localhost:3000/markitasauer/members/audiedare
created: false
id: rmMSRr
orbit_level: null
love: null
first_activity_occurred_at: null
last_activity_occurred_at: null
activities_count: 0
activities_score: 0
twitter: null
github: null
discourse: null
email: null
devto: null
linkedin: null
discord: null
github_followers: null
twitter_followers: null
topics: null
languages: null
relationships:
identities:
data: []
organizations:
data: []
- id: 9ABTo6
type: repository
attributes:
owner: leo
name: vernettaprohaska
full_name: leo/vernettaprohaska
updated_at: '2023-06-21T14:54:07.226Z'
created_at: '2023-06-21T14:54:07.226Z'
- id: OA3F51
type: user
attributes:
name: ClarettaKunzeIII
updated_at: '2023-06-21T14:54:07.203Z'
created_at: '2023-06-21T14:54:07.195Z'
/{workspace_slug}/members/{member_slug}/activities:
get:
summary: List activities for a member
tags:
- Activities
security:
- bearer: []
parameters:
- name: workspace_slug
in: path
required: true
schema:
type: string
- name: member_slug
in: path
required: true
schema:
type: string
- name: page
in: query
schema:
type: string
- name: direction
in: query
schema:
type: string
enum:
- ASC
- DESC
- name: items
in: query
schema:
type: string
enum:
- '10'
- '50'
- '100'
- name: sort
in: query
schema:
type: string
enum:
- occurred_at
- member
- name: activity_type
in: query
schema:
type: string
- name: type
in: query
deprecated: true
description: Deprecated in favor of the activity_type parameter.
schema:
type: string
responses:
'200':
description: success
content:
application/json:
example:
data:
- id: VlEsOe
type: spec_activity
attributes:
action: spec_action
created_at: '2023-06-21T14:54:11.610Z'
key: clé
occurred_at: '2023-06-21T14:54:11.609Z'
updated_at: '2023-06-21T14:54:11.610Z'
type: SpecActivity
properties:
prop_1: value_1
prop_2: value_2
tags:
- spec-tag-1
- spec-tag-2
orbit_url: http://web.archive.org/web/20240303060821/http://localhost:3000/parishuelphd/activities/VlEsOe
weight: '1.0'
relationships:
activity_type:
data:
id: oQQsBb
type: activity_type
member:
data:
id: BloSvr
type: member
included:
- id: oQQsBb
type: activity_type
attributes:
name: opine Mysource 34
short_name: Spec Channel
key: spec:activity
channel: mysource
source: mysource
weight: '1.0'
- id: BloSvr
type: member
attributes:
avatar_url: http://web.archive.org/web/20240303060821/http://github.com/avatar.png
bio: null
birthday: null
company: null
title: null
created_at: '2023-06-21T14:54:11.551Z'
deleted_at: null
location: null
name: DelphaLegros
pronouns: null
reach: 0
shipping_address: null
slug: delphalegros
source: installation
tag_list: []
tags: []
teammate: false
tshirt: null
updated_at: '2023-06-21T14:54:11.551Z'
merged_at: null
url: null
orbit_url: http://web.archive.org/web/20240303060821/http://localhost:3000/parishuelphd/members/delphalegros
created: false
id: BloSvr
orbit_level: null
love: null
first_activity_occurred_at: null
last_activity_occurred_at: null
activities_count: 0
activities_score: 0
twitter: null
github: null
discourse: null
email: null
devto: null
linkedin: null
discord: null
github_followers: null
twitter_followers: null
topics: null
languages: null
relationships:
identities:
data: []
organizations:
data: []
links:
first: /parishuelphd/members/delphalegros/activities?page=1&direction=DESC&items=10&sort=occurred_at&activity_type=spec%3Aactivity&type=
last: /parishuelphd/members/delphalegros/activities?page=1&direction=DESC&items=10&sort=occurred_at&activity_type=spec%3Aactivity&type=
prev: null
next: null
post:
summary: Create a Custom or a Content activity for a member
tags:
- Activities
security:
- bearer: []
parameters:
- name: workspace_slug
in: path
required: true
schema:
type: string
- name: member_slug
in: path
required: true
schema:
type: string
responses:
'201':
description: success
content:
application/json:
example:
data:
id: ZngsdG
type: custom_activity
attributes:
action: happened
created_at: '2023-06-21T14:54:12.696Z'
key: thing-123
occurred_at: '2023-06-21T14:54:12.693Z'
updated_at: '2023-06-21T14:54:12.696Z'
type: CustomActivity
properties: {}
tags:
- product
- enterprise
- channel:custom
- custom_type:custom-type
- custom_title:did-a-thing
orbit_url: http://web.archive.org/web/20240303060821/http://localhost:3000/mrcamerontowne/activities/ZngsdG
weight: '8.0'
custom_description: More info about the thing
custom_link: http://web.archive.org/web/20240303060821/http://link.com/
custom_link_text: See the thing
custom_title: Did a thing
custom_type: custom-type
custom_context: null
body: More info about the thing
relationships:
activity_type:
data:
id: 574seD
type: activity_type
member:
data:
id: 45PSyv
type: member
user:
data:
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/orbit/refs/heads/main/openapi/orbit-activities-api-openapi.yml