What an invitation offers

GET

/api/v1/invite/{token}

curl --request GET \
  --url http://localhost:3000/api/v1/invite/example

No key needed.

Parameters

Path Parameters

token

required

string

From the invitation link

Responses

200

The invitation

Media typeapplication/json

object

data

required

object

email

required

Who it was meant for

string

organization

required

string

resource

required

string

Allowed values: organization project collection asset brand

label

required

string | null

scope

required

string

Allowed values: read propose write admin

invitedBy

required

string

expiresAt

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

signUp

required

No account has this email yet

boolean

Example

{
  "data": {
    "resource": "organization",
    "scope": "read"
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}