Projects
Create, Update, Delete, List, and Show your Projects.
Project API Actions
| Action | Method | Path |
|---|---|---|
| List | GET | /api/v1/projects |
| Show | GET | /api/v1/projects/:id |
| Create | POST | /api/v1/projects |
| Update | PUT | /api/v1/projects/:id |
| Delete | DELETE | /api/v1/projects/:id |
List projects
You can return a list of your projects.
| Argument | Options |
|---|---|
| query (string, optional) | Filter your projects by name, or id |
| page (integer, optional) | Change the page |
Example API call
HTTPS
https://usebasin.com/api/v1/projects?filter_by=All&page=1&query=&api_token={account_api_token}
Make sure you swap out {account_api_token} with your account wide API token found on your Account Setting page.
Show/Delete a project
You can return the attributes of a single project or delete a project using its id.
| Argument | Options |
|---|---|
| id (integer) | The the project with this id |
Example API call
HTTPS
https://usebasin.com/api/v1/projects/{project_id}?api_token={account_api_token}
Make sure you swap out {account_api_token} with your account wide API token found on your Account Setting page.
Create/Update a project
The following attributes are available to you.
| Attribute | Type | |
|---|---|---|
| name | string | |
| timezone | string | The timzone you want all data for this project to be in. (default: UTC) |
| allowed_domains | string | Comma separated list of allowed domains. Only submissions from these domains (and all subdomains) will be accepted. |
| blocked_domains | string | Comma separated list of blocked domains. Submissions with email addresses from these domains (and all subdomains) will be blocked. |
Example API call
HTTPS
https://usebasin.com/api/v1/projects?api_token={account_api_token} {"project":{"name":"projectname",...}}
Make sure you swap out {account_api_token} with your account wide API token found on your Account Setting page.