-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.html
135 lines (100 loc) · 3.94 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="description" content="Remotebase-api : The official public API of RemoteBase">
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<title>Remotebase-api</title>
</head>
<body>
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/remotebase/remotebase-api">View on GitHub</a>
<h1 id="project_title">Remotebase-api</h1>
<h2 id="project_tagline">The official public API of RemoteBase</h2>
</header>
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h1>
<a id="remotebase-api" class="anchor" href="#remotebase-api" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>RemoteBase API</h1>
<p>The official API of <a href="https://remotebase.io">RemoteBase</a>.</p>
<p><strong>Currently not versioned. The API is still experimental and can change.</strong></p>
<h2>
<a id="what-is-remotebase" class="anchor" href="#what-is-remotebase" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>What is RemoteBase?</h2>
<p>RemoteBase is an open database of remote companies and jobs, made by a developer.</p>
<h2>
<a id="honor-code" class="anchor" href="#honor-code" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Honor code</h2>
<ul>
<li>Access the API at a reasonable rate.</li>
<li>Make something of your own. I don't mind if you build a clone of RemoteBase, but
the world needs to hear your voice, not mine.</li>
</ul>
<h2>
<a id="current-version" class="anchor" href="#current-version" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Current version</h2>
<p>Access the endpoints at <code>http://api.remotebase.io/</code>.</p>
<h2>
<a id="endpoints" class="anchor" href="#endpoints" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Endpoints</h2>
<h3>
<a id="companies" class="anchor" href="#companies" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Companies</h3>
<ul>
<li>
<p>List companies</p>
<p>List all companies, or ones that match the filter.</p>
<p><code>GET /companies</code></p>
<p><em>Parameters</em></p>
<ul>
<li>name [string] - name of the company</li>
<li>has_retreats [bool]</li>
<li>technologies [string] - single value for a technology</li>
<li>collaboration_methods [string] - A name of a collaboration method. Can supply multiple.</li>
<li>communication_methods [string] - A name of a communication method. Can supply multiple.</li>
<li>bootstrapped [bool]</li>
<li>is_standalone [bool]</li>
<li>team_size_min [number]</li>
<li>team_size_max [number]</li>
<li>page [int]</li>
<li>per_page [int]</li>
</ul>
<p><em>Response</em></p>
<pre><code>Status: 200 OK
Link: <http://api.remotebase.io/v1/companies?page=2>; rel=next"
[
{
name: "RemoteBase"
...
},
{
...
},
...
]
</code></pre>
</li>
</ul>
<h3>
<a id="jobs" class="anchor" href="#jobs" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>jobs</h3>
<ul>
<li>
<p>List jobs</p>
<p>List all jobs on RemoteBase</p>
<p><code>GET /jobs</code></p>
</li>
</ul>
<h2>
<a id="license" class="anchor" href="#license" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>License</h2>
<p>MIT</p>
</section>
</div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p class="copyright">Remotebase-api maintained by <a href="https://github.com/remotebase">remotebase</a></p>
<p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
</body>
</html>