Get an invite

Returns a single invite by its code. Only the invited email’s owner may view it.

GET

/v1/invites/{inviteCode}

const url = 'https://api.shiftsync.app/v1/invites/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://api.shiftsync.app/v1/invites/example \
  --header 'Authorization: Bearer <token>'

Authorizations

oauth2
invites:read

Parameters

Path Parameters

inviteCode

required

string

Responses

200

A single invite by code

application/json

object

item

required

object

required

integer

>= -9007199254740991 <= 9007199254740991

emailAddress

required

string format: email

/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

requestedAt

required

string format: date-time

firstName

required

string

lastName

string

inviteeEmailAddress

required

string format: email

/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

inviteCode

required

string

seen

boolean

Example

{
  "item": {
    "id": 0,
    "emailAddress": "user@example.com",
    "requestedAt": "2026-01-01T09:00:00.000Z",
    "firstName": "string",
    "lastName": "string",
    "inviteeEmailAddress": "user@example.com",
    "inviteCode": "string",
    "seen": true
  }
}