Every invite code, newest first (admin)

GET

/api/v1/invites

const url = 'https://example.com/api/v1/invites';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/invites

The invite table: label, role, dates and status. The codes themselves are not stored.

Responses

200

Successful Response

application/json

InviteList

All invites, newest first.

object

items

required

Items

Array<object>

InviteOut

An invite code as listed. The code itself is shown once, when it is made.

object

created_at

required

Created At

string format: date-time

created_by

Any of:

string
null

string

expires_at

Any of:

string
null

string format: date-time

required

string format: uuid

label

required

Label

string

max_uses

Any of:

integer
null

integer

revoked_at

Any of:

string
null

string format: date-time

role

required

Role

Authorization level of the caller, ordered viewer < reviewer < admin.

string

Allowed values: viewer reviewer admin

status

required

Status

string

Allowed values: active expired revoked spent

use_count

required

Use Count

integer

Example

{
  "items": [
    {
      "role": "viewer",
      "status": "active"
    }
  ]
}

401

Unauthorized

Problem

Application/problem+json body. Extension members (for example job_id) are allowed.

object

detail

Any of:

string
null

string

errors

Any of:

Array<object>
null

Array<object>

FieldError

One validation failure: where, what, and a stable machine code (never the input value).

object

loc

required

Loc

Array

msg

required

Msg

string

type

required

Type

string

instance

Any of:

string
null

string

request_id

required

Request Id

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

key

additional properties

any

Example

{
  "type": "about:blank"
}

403

Forbidden

Problem

Application/problem+json body. Extension members (for example job_id) are allowed.

object

detail

Any of:

string
null

string

errors

Any of:

Array<object>
null

Array<object>

FieldError

One validation failure: where, what, and a stable machine code (never the input value).

object

loc

required

Loc

Array

msg

required

Msg

string

type

required

Type

string

instance

Any of:

string
null

string

request_id

required

Request Id

string

status

required

Status

integer

title

required

Title

string

type

Type

string

default: about:blank

key

additional properties

any

Example

{
  "type": "about:blank"
}

Map data © OpenStreetMap contributors, under the Open Database Licence. Code under the Apache-2.0 licence. Made by Yogesh.

Changeset Second Opinion is an independent open source tool for OpenStreetMap reviewers. It is not endorsed by, sponsored by or affiliated with the OpenStreetMap Foundation. OpenStreetMap is a trademark of the OpenStreetMap Foundation, used under itstrademark policy.