getInvite

GET

/api/v1/invites/{token}

getInvite

curl --request GET \
  --url '<base-url>/api/v1/invites/<token>' \
  --cookie 'agenthold_session=<agenthold_session>'

const url = '<base-url>/api/v1/invites/<token>';
const options = {
  method: 'GET',
  headers: {cookie: 'agenthold_session=<agenthold_session>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "workspaceId": "string",
  "workspaceName": "string",
  "role": "admin",
  "invitedBy": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "alreadyMember": true
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

token
string
required

Returns

200

What accepting this invite would do.

JSON

workspaceId
string
required
workspaceName
string
required
role
admin
or
member
required
invitedBy
string
required
expiresAt
string
required
format: date-time
alreadyMember
boolean
required

404

Error.

JSON

error
string
required