Skip to main content
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)
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "permissions": [
        "CAN_PERFORM_ADMIN_ACTIONS"
      ],
      "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": "jsmith@example.com",
        "date_joined": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.clarifeye.ai/llms.txt

Use this file to discover all available pages before exploring further.

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
​
search
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

​
next
string<uri> | null

URL to next page of results

​
previous
string<uri> | null

URL to previous page of results

​
results
object[]