Users

List all users in your organization with optional filtering by seat assignment and role status. Supports cursor-based pagination.

GET /v1/users

cURL

cURL

curl --request GET \
  --url 'https://api.coderabbit.ai/v1/users?seat_filter=all&role_filter=all&limit=100' \
  --header 'x-coderabbitai-api-key: <api-key>'

import requests

url = 'https://api.coderabbit.ai/v1/users'

headers = {'x-coderabbitai-api-key': '<api-key>'}

params = {'seat_filter': 'all', 'role_filter': 'all', 'limit': 100}

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

print(response.text)

const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};

fetch('https://api.coderabbit.ai/v1/users?seat_filter=all&role_filter=all&limit=100', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://api.coderabbit.ai/v1/users?seat_filter=all&role_filter=all&limit=100"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-coderabbitai-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.coderabbit.ai/v1/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-coderabbitai-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://api.coderabbit.ai/v1/users")
  .header("x-coderabbitai-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.coderabbit.ai/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-coderabbitai-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

Example

{
  "seats_purchased": 50,
  "seats_assigned": 30,
  "seat_assignment_mode": "manual",
  "users": [
    {
      "user_id": "121358802",
      "seat_assigned": true,
      "role": "cr_admin"
    },
    {
      "user_id": "22605247",
      "seat_assigned": false,
      "role": "cr_member"
    }
  ],
  "next_cursor": "MjI2MDUyNDc="
}

Users List

Requires Admin role. See Role-based access for details.

Authorizations

x-coderabbitai-api-key · string · header · required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Headers

x-coderabbitai-api-key · string · required

Your CodeRabbit API key

Query Parameters

seat_filter · enum<string> · default: all

Filter users by seat assignment status

Available options: all, assigned, unassigned

role_filter · enum<string> · default: all

Filter users by role

Available options: all, member, admin

limit · integer · default: 100

Maximum number of users to return per page

Required range: 1 <= x <= 100

cursor · string

Pagination cursor from previous response's next_cursor field

Response

200

application/json

List of users with seat and subscription info

seats_purchased · integer · required

Total number of seats purchased in the subscription

seats_assigned · integer · required

Number of seats currently assigned to users

seat_assignment_mode · enum<string> · required

The seat assignment mode for the organization

Available options: automatic, manual

users · object[] · required

Show child attributes

next_cursor · string | null

Cursor for the next page of results, or null if no more results