Collaboration

#Get an invitation by token

GET/v1/invitations/{token}

Retrieve a single invitation using its token.

Path parameters

tokenstring

Invitation token

Response codes

200

401

Unauthorized

404

Not Found

curl "https://api.rendley.com/v1/invitations/TOKEN" \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://api.rendley.com/v1/invitations/TOKEN", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();

import requests

res = requests.get(
    "https://api.rendley.com/v1/invitations/TOKEN",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]

$ch = curl_init("https://api.rendley.com/v1/invitations/TOKEN");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY"]);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.rendley.com/v1/invitations/TOKEN", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}

require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/invitations/TOKEN")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

API key

tokenREQUIREDstring

Response

{
  "data": {
    "created_at": "string",
    "email": "string",
    "expires_at": "string",
    "id": "string",
    "invited_by": "string",
    "inviter_name": "string",
    "project_id": "string",
    "project_name": "string",
    "role": "string"
  }
}

#Accept an invitation

POST/v1/invitations/{token}/accept

Accept a collaboration invitation using its token.

Path parameters

tokenstring

Invitation token

Response codes

200

401

Unauthorized

404

Not Found

curl -X POST "https://api.rendley.com/v1/invitations/TOKEN/accept" \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://api.rendley.com/v1/invitations/TOKEN/accept", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();

import requests

res = requests.post(
    "https://api.rendley.com/v1/invitations/TOKEN/accept",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]

$ch = curl_init("https://api.rendley.com/v1/invitations/TOKEN/accept");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY"]);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.rendley.com/v1/invitations/TOKEN/accept", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}

require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/invitations/TOKEN/accept")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

API key

tokenREQUIREDstring

Response

{
  "data": {
    "created_at": "string",
    "id": "string",
    "role": "string",
    "user_email": "string",
    "user_id": "string",
    "user_image": "string",
    "user_name": "string"
  }
}

#Decline an invitation

POST/v1/invitations/{token}/decline

Decline a collaboration invitation using its token.

Path parameters

tokenstring

Invitation token

Response codes

200

401

Unauthorized

404

Not Found

curl -X POST "https://api.rendley.com/v1/invitations/TOKEN/decline" \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://api.rendley.com/v1/invitations/TOKEN/decline", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();

import requests

res = requests.post(
    "https://api.rendley.com/v1/invitations/TOKEN/decline",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]

$ch = curl_init("https://api.rendley.com/v1/invitations/TOKEN/decline");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY"]);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.rendley.com/v1/invitations/TOKEN/decline", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}

require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/invitations/TOKEN/decline")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

API key

tokenREQUIREDstring

#List collaborators

GET/v1/projects/{projectId}/collaborators

Retrieve all collaborators for a project.

Path parameters

projectIdstring

Project ID

Response codes

200

401

Unauthorized

403

Forbidden

curl "https://api.rendley.com/v1/projects/PROJECT_ID/collaborators" \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://api.rendley.com/v1/projects/PROJECT_ID/collaborators", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();

import requests

res = requests.get(
    "https://api.rendley.com/v1/projects/PROJECT_ID/collaborators",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]

$ch = curl_init("https://api.rendley.com/v1/projects/PROJECT_ID/collaborators");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY"]);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.rendley.com/v1/projects/PROJECT_ID/collaborators", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}

require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/projects/PROJECT_ID/collaborators")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

API key

projectIdREQUIREDstring

Response

{
  "data": [
    {
      "created_at": "string",
      "id": "string",
      "role": "string",
      "user_email": "string",
      "user_id": "string",
      "user_image": "string",
      "user_name": "string"
    }
  ]
}

#Update a collaborator's role

PATCH/v1/projects/{projectId}/collaborators/{userId}

Update the role of a collaborator on a project.

Path parameters

projectIdstring

Project ID

userIdstring

User ID

Request body

role"viewer" | "editor"Required

Response codes

200

400

Bad Request

401

Unauthorized

403

Forbidden

curl -X PATCH "https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "viewer"
  }'

const res = await fetch("https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID", {
  method: "PATCH",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    "role": "viewer"
  }),
});
const { data } = await res.json();

import requests

res = requests.patch(
    "https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
      "role": "viewer"
    },
)
data = res.json()["data"]

$ch = curl_init("https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["role" => "viewer"]));

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];

package main

import (
	"fmt"
	"io"
	"net/http"
	"bytes"
)

func main() {
	body := bytes.NewBufferString(`{
  "role": "viewer"
}`)
	req, _ := http.NewRequest("PATCH", "https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID", body)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}

require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID")
req = Net::HTTP::Patch.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"
req["Content-Type"] = "application/json"
req.body = { role: "viewer" }.to_json

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

API key

projectIdREQUIREDstring

userIdREQUIREDstring

Body

roleREQUIRED"viewer" | "editor"

#Remove a collaborator

DELETE/v1/projects/{projectId}/collaborators/{userId}

Remove a collaborator from a project.

Path parameters

projectIdstring

Project ID

userIdstring

User ID

Response codes

200

401

Unauthorized

403

Forbidden

curl -X DELETE "https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID", {
  method: "DELETE",
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();

import requests

res = requests.delete(
    "https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]

$ch = curl_init("https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY"]);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}

require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/projects/PROJECT_ID/collaborators/USER_ID")
req = Net::HTTP::Delete.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

API key

projectIdREQUIREDstring

userIdREQUIREDstring

#List invitations

GET/v1/projects/{projectId}/invitations

Retrieve all invitations for a project.

Path parameters

projectIdstring

Project ID

Response codes

200

401

Unauthorized

403

Forbidden

curl "https://api.rendley.com/v1/projects/PROJECT_ID/invitations" \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://api.rendley.com/v1/projects/PROJECT_ID/invitations", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();

import requests

res = requests.get(
    "https://api.rendley.com/v1/projects/PROJECT_ID/invitations",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]

$ch = curl_init("https://api.rendley.com/v1/projects/PROJECT_ID/invitations");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY"]);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.rendley.com/v1/projects/PROJECT_ID/invitations", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}

require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/projects/PROJECT_ID/invitations")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

API key

projectIdREQUIREDstring

Response

{
  "data": [
    {
      "created_at": "string",
      "email": "string",
      "expires_at": "string",
      "id": "string",
      "invited_by": "string",
      "inviter_name": "string",
      "project_id": "string",
      "project_name": "string",
      "role": "string"
    }
  ]
}

#Create an invitation

POST/v1/projects/{projectId}/invitations

Invite a user to collaborate on a project.

Path parameters

projectIdstring

Project ID

Request body

emailstringRequired

role"viewer" | "editor"Required

Response codes

200

400

Bad Request

401

Unauthorized

403

Forbidden

curl -X POST "https://api.rendley.com/v1/projects/PROJECT_ID/invitations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "<email>",
    "role": "viewer"
  }'

const res = await fetch("https://api.rendley.com/v1/projects/PROJECT_ID/invitations", {
  method: "POST",
  headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
  body: JSON.stringify({
    "email": "<email>",
    "role": "viewer"
  }),
});
const { data } = await res.json();

import requests

res = requests.post(
    "https://api.rendley.com/v1/projects/PROJECT_ID/invitations",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
      "email": "<email>",
      "role": "viewer"
    },
)
data = res.json()["data"]

$ch = curl_init("https://api.rendley.com/v1/projects/PROJECT_ID/invitations");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(["email" => "<email>", "role" => "viewer"]));

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];

package main

import (
	"fmt"
	"io"
	"net/http"
	"bytes"
)

func main() {
	body := bytes.NewBufferString(`{
  "email": "<email>",
  "role": "viewer"
}`)
	req, _ := http.NewRequest("POST", "https://api.rendley.com/v1/projects/PROJECT_ID/invitations", body)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}

require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/projects/PROJECT_ID/invitations")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"
req["Content-Type"] = "application/json"
req.body = { email: "<email>", role: "viewer" }.to_json

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

API key

projectIdREQUIREDstring

Body

emailREQUIREDstring

roleREQUIRED"viewer" | "editor"

Response

{
  "data": {
    "created_at": "string",
    "email": "string",
    "expires_at": "string",
    "id": "string",
    "invited_by": "string",
    "inviter_name": "string",
    "project_id": "string",
    "project_name": "string",
    "role": "string"
  }
}

#Delete an invitation

DELETE/v1/projects/{projectId}/invitations/{invitationId}

Delete a pending invitation from a project.

Path parameters

projectIdstring

Project ID

invitationIdstring

Invitation ID

Response codes

200

401

Unauthorized

403

Forbidden

curl -X DELETE "https://api.rendley.com/v1/projects/PROJECT_ID/invitations/INVITATION_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://api.rendley.com/v1/projects/PROJECT_ID/invitations/INVITATION_ID", {
  method: "DELETE",
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();

import requests

res = requests.delete(
    "https://api.rendley.com/v1/projects/PROJECT_ID/invitations/INVITATION_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]

$ch = curl_init("https://api.rendley.com/v1/projects/PROJECT_ID/invitations/INVITATION_ID");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY"]);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.rendley.com/v1/projects/PROJECT_ID/invitations/INVITATION_ID", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}

require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/projects/PROJECT_ID/invitations/INVITATION_ID")
req = Net::HTTP::Delete.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

API key

projectIdREQUIREDstring

invitationIdREQUIREDstring

#List shared projects

GET/v1/projects/shared

Retrieve all projects shared with the authenticated user.

Response codes

200

401

Unauthorized

curl "https://api.rendley.com/v1/projects/shared" \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://api.rendley.com/v1/projects/shared", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});
const { data } = await res.json();

import requests

res = requests.get(
    "https://api.rendley.com/v1/projects/shared",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()["data"]

$ch = curl_init("https://api.rendley.com/v1/projects/shared");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer YOUR_API_KEY"]);

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true)["data"];

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.rendley.com/v1/projects/shared", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	b, _ := io.ReadAll(res.Body)
	fmt.Println(string(b))
}

require "net/http"
require "json"

uri = URI("https://api.rendley.com/v1/projects/shared")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)["data"]

API key