---
title: "Gets a user invite url"
method: GET
path: "/users/{user_id}/user-invite-url"
tags: ["Users"]
---

# Gets a user invite url

`GET /users/{user_id}/user-invite-url`

## Request

- Base URL: `https://api.kontainer.com/jsonapi/v2`
- URL: `https://api.kontainer.com/jsonapi/v2/users/{user_id}/user-invite-url`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kontainer/apis/kontainer-api-documentation/docs/users/:user_id/user-invite-url/get.ts> (a function with typed inputs; its response is checked against the schema)

## Gets a user invite url
Endpoint for retrieving a generated invitation url associated with user.

## Path parameters

- `user_id` string, required

## Response `200`

success

- InviteUrlResponse
  - `data` object
    - `type` string
    - `id` string
    - `attributes` object
      - `invite_url` string, uri

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `422`: The invite link has either expired or needs to be generated

---

[API](https://skmtc.dev/kontainer/apis/kontainer-api-documentation.md) - [All operations](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/revisions/b80a5167e09a?raw)