List invitations

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/invites/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/invites/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[email protected]",
      "permissions": [
        "CAN_PERFORM_ADMIN_ACTIONS"
      ],
      "profile": "contributor",
      "status": "pending",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "invited_by": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "[email protected]",
        "date_joined": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

GET

projects

{project_id}

invites

List invitations

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/invites/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/invites/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[email protected]",
      "permissions": [
        "CAN_PERFORM_ADMIN_ACTIONS"
      ],
      "profile": "contributor",
      "status": "pending",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "invited_by": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "[email protected]",
        "date_joined": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer

Path Parameters

project_id

string<uuid>

required

UUID of the project

Query Parameters

status

enum<string>

Filter by invitation status

pending: Invitation sent, awaiting response
accepted: User accepted the invitation
cancelled: Invitation was cancelled

Available options:

pending,

accepted,

cancelled

string

Filter by email (case-insensitive partial match)

limit

integer

default:100

Maximum number of results per page

Required range: 1 <= x <= 1000

offset

integer

default:0

Number of results to skip for pagination

Required range: x >= 0

Response

Successful response

count

integer

Total number of results

string<uri> | null

URL to next page of results

string<uri> | null

URL to previous page of results

results

object[]

Show child attributes

Concepts

Endpoints

List invitations

Authorizations

Path Parameters

Query Parameters

Response