Get a member invitation

Retrieve details of a member invitation specified by ID for this Organization.

GET /member-invitations/{invitation_id}

Get a member invitation

cURL

curl --request GET \
  --url https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "id": "uinv_12345678abcdefgh",
  "organization_id": "org_12345678abcdefgh",
  "inviter": {
    "name": "Allison the Admin"
  },
  "invitee": {
    "email": "[e-mail]"
  },
  "identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
  "created_at": "2025-04-11T20:11:45.431Z",
  "expires_at": "2025-04-11T20:11:45.431Z",
  "roles": [
    "rol_BKW1BKIfBKd0BaI0"
  ],
  "invitation_url": "https://example.auth0.com/login?invitation=uinv_12345678abcdefgh&organization=org_12345678abcdefgh",
  "ticket_id": "1asdfasd23usjdef"
}

{
  "type": "https://auth0.com/api-errors#A0E-400-0003",
  "status": 400,
  "title": "Validation Error",
  "validation_errors": [
    {
      "detail": "is required",
      "field": "data/property_name",
      "pointer": "/property_name",
      "source": "params"
    }
  ]
}

{
  "type": "https://auth0.com/api-errors#A0E-401-0002",
  "status": 401,
  "title": "Missing Token",
  "detail": "No auth token provided."
}

{
  "type": "https://auth0.com/api-errors#A0E-403-0002",
  "status": 403,
  "title": "Insufficient Scope",
  "detail": "The auth token lacks the required scope: Check the API documentation for the required scopes for this endpoint."
}

{
  "type": "https://auth0.com/api-errors#A0E-404-0002",
  "status": 404,
  "title": "Resource Not Found",
  "detail": "The organization does not exist."
}

{
  "type": "https://auth0.com/api-errors#A0E-429-0003",
  "status": 429,
  "title": "Endpoint Rate Limit Exceeded",
  "detail": "The endpoint request limit has been exceeded."
}

承認

OAuth2ClientCredentialsOAuth2AuthCode

Authorization · string · header · 必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

invitation_id · string · 必須 · read-only

The id of the member invitation

Pattern: ^uinv_[A-Za-z0-9]{16}$

クエリパラメータ

fields · string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields. Note: you cannot filter on ticket_id and this value will only be returned when fields are not filtered.

Required string length: 1 - 255

Pattern: ^(id|organization_id|inviter|invitee|identity_provider_id|created_at|expires_at|roles|invitation_url)(,(id|organization_id|inviter|invitee|identity_provider_id|created_at|expires_at|roles|invitation_url))*$

include_fields · boolean · デフォルト: true

Whether specified fields are to be included (true) or excluded (false). Defaults to true

レスポンス

200

application/json

Get Member Invitation for an Organization by Id.

id · string · read-only

The id of the member invitation

Pattern: ^uinv_[A-Za-z0-9]{16}$

organization_id · string · read-only

Organization identifier.

Pattern: ^org_[A-Za-z0-9]{16}$

inviter · object

Show child attributes

invitee · object

Show child attributes

identity_provider_id · string · read-only

Identity provider identifier.

Pattern: ^con_[A-Za-z0-9]{16}$

created_at · string<date-time>

The ISO 8601 formatted timestamp representing the creation time of the invitation.

expires_at · string<date-time>

The ISO 8601 formatted timestamp representing the expiration time of the invitation.

roles · string[] · read-only

The ID of a role that can be assigned to a member of an organization.

Pattern: ^rol_[A-Za-z0-9]{16}$

invitation_url · string<uri>

The invitation url to be sent to the invitee.

ticket_id · string

The ID of the invitation ticket.