params.json

{
  "name": "Remotebase-api",
  "tagline": "The official public API of RemoteBase",
  "body": "# RemoteBase API\r\n\r\nThe official API of [RemoteBase](https://remotebase.io).\r\n\r\n**Currently not versioned. The API is still experimental and can change.**\r\n\r\n\r\n## What is RemoteBase?\r\n\r\nRemoteBase is an open database of remote companies and jobs, made by a developer.\r\n\r\n\r\n## Honor code\r\n\r\n* Access the API at a reasonable rate.\r\n* Make something of your own. I don't mind if you build a clone of RemoteBase, but\r\nthe world needs to hear your voice, not mine.\r\n\r\n## Current version\r\n\r\nThe current API version is `v1`. Access the endpoints at `http://api.remotebase.io/`.\r\n\r\n\r\n## Endpoints\r\n\r\n### Companies\r\n\r\n* List companies\r\n\r\n  List all companies, or ones that match the filter.\r\n\r\n  `GET /companies`\r\n\r\n  *Parameters*\r\n\r\n  * name [string] - name of the company\r\n  * has_retreats [bool]\r\n  * technologies [string] - single value for a technology\r\n  * collaboration_methods [string] - A name of a collaboration method. Can supply multiple.\r\n  * communication_methods [string] - A name of a communication method. Can supply multiple.\r\n  * bootstrapped [bool]\r\n  * is_standalone [bool]\r\n  * team_size_min [number]\r\n  * team_size_max [number]\r\n  * page [int]\r\n  * per_page [int]\r\n\r\n\r\n  *Response*\r\n  ```\r\n  Status: 200 OK\r\n  Link: <http://api.remotebase.io/v1/companies?page=2>; rel=next\"\r\n\r\n  [\r\n    {\r\n      name: \"RemoteBase\"\r\n      ...\r\n    },\r\n    {\r\n      ...\r\n    },\r\n    ...\r\n  ]\r\n  ```\r\n\r\n### jobs\r\n\r\n* List jobs\r\n\r\n  List all jobs on RemoteBase\r\n\r\n  `GET /jobs`\r\n\r\n## License\r\n\r\nMIT\r\n",
  "note": "Don't delete this file! It's used internally to help with page regeneration."
}