List Collaborators who have not yet accepted the invitations
1 min
GET
https://api.optimizely.com/v2/invitations
Query Parameters
- project_idinteger[]Description
Responses
200
- CollaboratorEntry[]
- idstring<uuid>ExampleDescriptionFormatuuid
- profileUserProfile
- emailstring<email>DescriptionFormatemail
- first_namestringDescriptionDefault
- last_namestringDescriptionDefault
- profile_imagestring<url>DescriptionDefaultFormaturl
- project_rolesProjectRole[]
- invitation_statusstring<pending>Allowedpending
- project_idinteger<int64>DescriptionFormatint64
- rolestring<administrator | viewer | restricted_editor | editor | restricted_publisher | publisher | project_owner>Allowedadministratorviewerrestricted_editoreditorrestricted_publisherpublisherproject_owner
401
- Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>Formatuuid
default
- Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>Formatuuid
curl
curl --request GET \
--url https://api.optimizely.com/v2/invitations \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.optimizely.com/v2/invitations", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.optimizely.com/v2/invitations")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.optimizely.com/v2/invitations"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Return pending collaborators
[
{
"id": "fa74a14b-1f3a-463d-aa98-2f7124ee6fc3",
"profile": {
"email": "",
"first_name": "",
"last_name": "",
"profile_image": ""
},
"project_roles": [
{
"invitation_status": "",
"project_id": "",
"role": ""
}
]
}
]401
// Invalid credentials
{
"code": "",
"message": "",
"messages": {},
"uuid": ""
}default
// Unexpected error
{
"code": "",
"message": "",
"messages": {},
"uuid": ""
}