Skip to main content
GET
/
v1
/
invitations
/
{id}
Get an Invitation
curl --request GET \
  --url https://api.edgee.app/v1/invitations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "object": "project",
  "id": "<string>",
  "organization_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "role": "admin",
  "email": "<string>",
  "created_at": "2022-03-01T00:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token. More info here

Path Parameters

​
id
string
required

Response

The retrieved Invitation

An invitation is a request to join an organization. An invitation is sent to an email address, and the recipient can accept or decline the invitation.

​
object
string

String representing the object's type. Objects of the same type share the same value

Example:

"project"

​
id
string

Unique identifier for the invitation

​
organization_id
string

Unique identifier for the organization the project belongs to

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

​
role
enum<string>

The future role of the user in the organization.

Available options:
admin,
editor,
member
​
email
string

Email of the user

​
created_at
string<date-time>

Time at which the project was created

Example:

"2022-03-01T00:00:00Z"