Projects

Create, Update, Delete, List, and Show your Projects.

Project API Actions


ActionMethodPath
ListGET/api/v1/projects
Show GET /api/v1/projects/:id
CreatePOST/api/v1/projects
UpdatePUT/api/v1/projects/:id
DeleteDELETE/api/v1/projects/:id

List projects


You can return a list of your projects.

ArgumentOptions
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.

ArgumentOptions
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.

AttributeType
namestring
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_domainsstring 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.