Read one invitation

GET

/v1/org/get-invitation

const url = 'https://your-tenant-host/v1/org/get-invitation?id=01926f3a-8b50-7d77-8188-7a8b9c0d1e2f';
const options = {
  method: 'GET',
  headers: {
    cookie: 'ek.session_token=<ek.session_token>',
    'x-edgekit-site-id': 'site_example'
  }
};

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://your-tenant-host/v1/org/get-invitation?id=01926f3a-8b50-7d77-8188-7a8b9c0d1e2f' \
  --header 'x-edgekit-site-id: site_example' \
  --cookie ek.session_token=<ek.session_token>

Requires the user’s own session. An unauthenticated read would hand anyone holding a forwarded invitation id the organization’s name and the inviter’s address.

Authorizations

UserSession

Parameters

Query Parameters

required

string format: uuid

>= 1 characters <= 128 characters

Example

01926f3a-8b50-7d77-8188-7a8b9c0d1e2f

Header Parameters

x-edgekit-site-id

required

The site this request is for, within this tenant. Every official EdgeKit SDK sets it from the client you configured; set it yourself only when calling this API directly.

string

>= 1 characters <= 128 characters

Example

site_example

The site this request is for, within this tenant. Every official EdgeKit SDK sets it from the client you configured; set it yourself only when calling this API directly.

Responses

200

The invitation.

application/json

object

required

string format: uuid

organizationId

required

string format: uuid

email

required

string

role

required

Open: accept a member not listed. Known: owner, admin, member.

string | null

status

required

Open: accept a member not listed. Known: pending, accepted, rejected, canceled.

string | null

expiresAt

required

string | null format: date-time

Example

{
  "id": "01926f3a-8b50-7d77-8188-7a8b9c0d1e2f",
  "organizationId": "01926f3a-8b4e-7b33-a944-5e6f7a8b9c0d",
  "email": "ada@example.com",
  "role": "owner",
  "status": "pending",
  "expiresAt": "2026-08-02T09:00:00.000Z"
}

400

Invalid request.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

401

Missing or invalid credential.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

403

Not allowed.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

404

Resource not found.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

422

Request validation failed.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

500

Unexpected error.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}