/organizations/{organization_id}/settings/projects

This endpoint allows you to create and manage projects.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/projects" -X GET \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer access_token" \
	-H "Host: example.org" \
	-H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
name Required string Name of project
organization_id Required integer ID of organization

Success Response Codes

  • 200 OK
  • 201 Created

Error Response Codes

  • 422 Unprocessable Entity

Response Attributes (POST and PUT)

Name Type Description
name string Name of project
id integer Project ID

List an organization's projects

GET /organizations/{organization_id}/settings/projects

Request Example

curl -g "http://shares.example.com/organizations/32400255/settings/projects" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
Link: 
X-Pagination: {"total_count":1,"total_pages":1,"first_page":true,"last_page":true,"previous_page":null,"next_page":null}
ETag: W/"6af42df7e072442e2e27933341a9aaec"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1d7f79a5-3cf3-40ab-9f86-d984f18c7a60
X-Runtime: 0.017421
Content-Length: 31

Success Response Example

200 OK
[
  {
    "id": 800313582,
    "name": "Pro"
  }
]


Get a specific project

GET /organizations/{organization_id}/projects/{project_id}/settings/project

Request Example

curl -g "http://shares.example.com/organizations/32400255/projects/800313582/settings/project" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"8638380ed5fef3b73864723da825d122"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 96a2726a-8344-4407-a3c3-31bab79e1a1a
X-Runtime: 0.033798
Content-Length: 29

Success Response Example

200 OK
{
  "id": 800313582,
  "name": "Pro"
}


Create new project

POST /organizations/{organization_id}/settings/projects

Request Example

curl "http://shares.example.com/organizations/32400255/settings/projects" -d '{"name":"API Create project"}' -X POST

Response Headers

X-Frame-Options: SAMEORIGIN
  X-XSS-Protection: 1; mode=block
  X-Content-Type-Options: nosniff
  Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
  Content-Type: application/json; charset=utf-8
  ETag: W/"5efc1e439b7abd47f969927c2d9e293d"
  Cache-Control: max-age=0, private, must-revalidate
  X-Request-Id: 2ee0f39c-f3cd-45ce-8cdf-b2fa31e0dd40
  X-Runtime: 0.026564
  Content-Length: 44

Success Response Example

201 Created
{
  "id": 800313584,
  "name": "API Create project"
  }

Error Response Example

422 Unprocessable Entity
{
      "errors": {
      "name": [
      "can't be blank"
      ]
      }
      }

Troubleshooting: Look for an empty value for "name" in the request body:

{"name":""}


Update a project

PUT /organizations/{organization_id}/projects/{project_id}/settings/project

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project" -d '{"name":"API Update project"}' -X PUT

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"4089c8c80e99cba87a18f24358b4559d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: cc6ce083-a56f-4360-8465-423b07189529
X-Runtime: 0.024072
Content-Length: 44

Success Response Example

200 OK
{
  "id": 800313582,
  "name": "API Update project"
}

Error Response Example

422 Unprocessable Entity
{
  "errors": {
    "name": [
      "can't be blank"
    ]
  }
}

Troubleshooting: Look for an empty value for "name" in the request body:

{"name":""}


Remove a user from a project

DELETE /organizations/{organization_id}/projects/{project_id}/settings/project

Request Example

curl "http://shares.example.com/organizations/32400255/projects/800313582/settings/project" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
  X-XSS-Protection: 1; mode=block
  X-Content-Type-Options: nosniff
  Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
  Cache-Control: no-cache
  X-Request-Id: a231be28-de9a-400e-9cd3-35351d870a44
  X-Runtime: 0.034193

Success Response Example

204 No Content

Video player

Video

×