Skip to content
Buzz

List private-site readers

GET
/sites/{site_name}/access/readers
curl --request GET \
  --url https://example.com/sites/example/access/readers \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
site_name
required
Site Name
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Listsitereaders
Array<object>
SiteReaderResponse
object
avatar_url
required
Any of:
string
github_login
required
Github Login
string
github_name
required
Any of:
string
id
required
Id
integer
Examplegenerated
[
  {
    "avatar_url": "example",
    "github_login": "example",
    "github_name": "example",
    "id": 1
  }
]

401

Section titled “401”

Authentication is required.

Media typeapplication/json
ErrorResponse
object
detail
required
Detail
string
Examplegenerated
{
  "detail": "example"
}

403

Section titled “403”

Site ownership is required.

Media typeapplication/json
ErrorResponse
object
detail
required
Detail
string
Examplegenerated
{
  "detail": "example"
}

404

Section titled “404”

The site was not found.

Media typeapplication/json
ErrorResponse
object
detail
required
Detail
string
Examplegenerated
{
  "detail": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}