{ "opencollection": "1.0.0", "info": { "name": "Orbit Activities Members API", "version": "v1" }, "items": [ { "info": { "name": "Members", "type": "folder" }, "items": [ { "info": { "name": "Add identity to a member", "type": "http" }, "http": { "method": "POST", "url": "http://web.archive.org/web/20240303060821/https://app.orbit.love/api/v1/:workspace_slug/members/:member_slug/identities", "params": [ { "name": "workspace_slug", "value": "", "type": "path" }, { "name": "member_slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Add identity to a member" }, { "info": { "name": "Remove identity from a member", "type": "http" }, "http": { "method": "DELETE", "url": "http://web.archive.org/web/20240303060821/https://app.orbit.love/api/v1/:workspace_slug/members/:member_slug/identities", "params": [ { "name": "workspace_slug", "value": "", "type": "path" }, { "name": "member_slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Remove identity from a member" }, { "info": { "name": "List members in a workspace", "type": "http" }, "http": { "method": "GET", "url": "http://web.archive.org/web/20240303060821/https://app.orbit.love/api/v1/:workspace_slug/members", "params": [ { "name": "workspace_slug", "value": "", "type": "path" }, { "name": "affiliation", "value": "", "type": "query" }, { "name": "member_tags", "value": "", "type": "query", "description": "The list of tags to filter against. Separate tags with `,` to do an intersection (AND), or with `|` to do a union (OR)" }, { "name": "orbit", "value": "", "type": "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." }, { "name": "activity_type", "value": "", "type": "query", "description": "Comma separated list of activity types" }, { "name": "identity", "value": "", "type": "query" }, { "name": "company[]", "value": "", "type": "query", "description": "Comma separated list of companies. The union (OR) of companies is applied." }, { "name": "title[]", "value": "", "type": "query", "description": "Comma separated list of job titles. The union (OR) of job titles is applied." }, { "name": "regions[]", "value": "", "type": "query", "description": "Comma separated list of regions. The union (OR) of regions is applied." }, { "name": "countries[]", "value": "", "type": "query", "description": "Comma separated list of countries. The union (OR) of countries is applied." }, { "name": "cities[]", "value": "", "type": "query", "description": "Comma separated list of cities. The union (OR) of cities is applied." }, { "name": "start_date", "value": "", "type": "query", "description": "Filter activities after this date. Format: YYYY-MM-DD." }, { "name": "end_date", "value": "", "type": "query", "description": "Filter activities before this date. Format: YYYY-MM-DD." }, { "name": "relative", "value": "", "type": "query", "description": "Relative timeframes. Format: this__, with period in [days, weeks, months, years]. For example, this_30_days." }, { "name": "query", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "items", "value": "", "type": "query" }, { "name": "activities_count_min", "value": "", "type": "query" }, { "name": "activities_count_max", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query", "description": "Deprecated in favor of the activity_type parameter." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List members in a workspace" }, { "info": { "name": "Create or update a member", "type": "http" }, "http": { "method": "POST", "url": "http://web.archive.org/web/20240303060821/https://app.orbit.love/api/v1/:workspace_slug/members", "params": [ { "name": "workspace_slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This 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 specified in the identity object or member attributes like member.github. If no member exists, a new member will be created and linked to any provided identities." }, { "info": { "name": "Get a member", "type": "http" }, "http": { "method": "GET", "url": "http://web.archive.org/web/20240303060821/https://app.orbit.love/api/v1/:workspace_slug/members/:member_slug", "params": [ { "name": "workspace_slug", "value": "", "type": "path" }, { "name": "member_slug", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a member" }, { "info": { "name": "Update a member", "type": "http" }, "http": { "method": "PUT", "url": "http://web.archive.org/web/20240303060821/https://app.orbit.love/api/v1/:workspace_slug/members/:member_slug", "params": [ { "name": "workspace_slug", "value": "", "type": "path" }, { "name": "member_slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a member" }, { "info": { "name": "Delete a member", "type": "http" }, "http": { "method": "DELETE", "url": "http://web.archive.org/web/20240303060821/https://app.orbit.love/api/v1/:workspace_slug/members/:member_slug", "params": [ { "name": "workspace_slug", "value": "", "type": "path" }, { "name": "member_slug", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a member" }, { "info": { "name": "Find a member by an identity", "type": "http" }, "http": { "method": "GET", "url": "http://web.archive.org/web/20240303060821/https://app.orbit.love/api/v1/:workspace_slug/members/find", "params": [ { "name": "workspace_slug", "value": "", "type": "path" }, { "name": "source", "value": "", "type": "query" }, { "name": "source_host", "value": "", "type": "query" }, { "name": "uid", "value": "", "type": "query" }, { "name": "username", "value": "", "type": "query" }, { "name": "email", "value": "", "type": "query" }, { "name": "github", "value": "", "type": "query", "description": "Deprecated, please use source=github and username= instead" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Provide 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, and email." }, { "info": { "name": "List members in an organization", "type": "http" }, "http": { "method": "GET", "url": "http://web.archive.org/web/20240303060821/https://app.orbit.love/api/v1/:workspace_slug/organizations/:organization_id/members", "params": [ { "name": "workspace_slug", "value": "", "type": "path" }, { "name": "organization_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "items", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List members in an organization" } ] } ], "bundled": true }