Skip to content
Kindgi

Fetch a corrector group

View as Markdown
GET
/v1/corrector-groups/{correctorGroupId}
curl --request GET \
  --url https://example.com/v1/corrector-groups/example \
  --header 'Authorization: Bearer <token>'

Also returns a retired group (unregisteredAt set): corrections keep naming theirs.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
correctorGroupId
required
string
>= 1 characters

Corrector group id.

Responses

Section titled “Responses”

200

Section titled “200”

Corrector group.

Media typeapplication/json
object
id
required
string
tenantId
required
string
scope
required
One of:
object
kind
required
string
Allowed value: tenant
name
required

The deployment’s own word for the group: “expert”, “user”, “arbitrator”.

string
weight
required

How much a correction of this group counts, relative to the others.

number
description
string
assertableBy

Who may assert the group, as the caller sees it: every part that is set must hold. principalIds is sent only to an admin on the group’s scope; principalCount to everyone who reads it.

object
>= 1 properties
minReviewerRole

The caller’s reviewer role is at least this (its token’s, or the roster’s).

string
Allowed values: standard senior admin
principalKinds

Users, service tokens, or both.

Array<string>
>= 1 items
Allowed values: user service
principalIds

Only these principals: user ids, or service token ids. Sent only to an admin on the group’s scope.

Array<string>
>= 1 items <= 100 items
principalCount

How many principals the group is restricted to (principalIds), for every reader. Absent when it names none.

integer
>= 1
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
unregisteredAt

Set when the group was retired.

string format: date-time
Example
{
  "scope": {
    "kind": "tenant"
  },
  "assertableBy": {
    "minReviewerRole": "standard",
    "principalKinds": [
      "user"
    ]
  }
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No corrector group with that id under this tenant.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

503

Section titled “503”

The database was too busy to answer in time (database-busy); Retry-After (whole seconds) says when to try again.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also