List pending invites

Management API · User Management

GET https://app.mk.io/api/v1/organization/invites

This endpoint shows the current list of invitations that have been sent by this MK.IO organization and which have not been accepted or declined yet.

RBAC Capability Required: core.invite.get

Authentication

• Authorization header — Bearer authentication of the form Bearer <token>.

Example request

curl -X GET "https://app.mk.io/api/v1/organization/invites" \
  -H "Authorization: Bearer <token>"

Responses

200 — OK

• kind · string · Required — The kind of record.
• value · list of objects · Required — List of pending invites
  • Array items (object):
    • kind · string · Optional — The kind of record.
    • metadata · object · Optional — Metadata
      • created · string · Optional · format: date-time — The time when the resource was created
      • id · string · Required · format: uuid — The ID of the resource
    • spec · object · Required — Specification
      • comment · string · Required — Comment to explain why the user has been invited to collaborate with your organization
      • email · string · Required — Email of the user to be invited
      • invitedByEmail · string · Required — Contact email of user who made the invite
      • invitedByName · string · Required — Name of user who made the invite
      • organizationName · string · Required — Name of the organization the invite refers to
      • teams · list of strings · Optional — List of team names to add this user to when they accept.
        • Array items (string):

Example:

{
  "kind": "string",
  "value": [
    {
      "kind": "string",
      "metadata": {
        "created": "2024-01-01T00:00:00Z",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "spec": {
        "comment": "string",
        "email": "string",
        "invitedByEmail": "string",
        "invitedByName": "string",
        "organizationName": "string",
        "teams": [
          "string"
        ]
      }
    }
  ]
}

400 — Bad Request

• error · object · Required — Pertinent information about the error
  • code · string · Required — The error code.
  • detail · string · Required — The error message.
  • extraDetail · map from strings to any · Optional — Extra information regarding this error.
    • [any key] · any — map of additional properties
• ref · string · Required — A reference to the request that caused the error.
• status · integer · Required — The HTTP status code

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

401 — Unauthorized

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

403 — Forbidden

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

404 — Not Found

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

429 — Too Many Requests

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

500 — Internal Server Error

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

Source spec: management-api · operationId: [get]_/api/v1/organization/invites