API referenceUsers

List pending invites

Lists your organization's pending invites, newest first: people who were invited and haven't joined yet. Requires the organization:user.read permission.

GET/users/invites

https://sandbox.api.mothership.com/beta

curl --request GET \
  --url 'https://sandbox.api.mothership.com/beta/users/invites' \
  --header "Authorization: Bearer $MOTHERSHIP_API_TOKEN" \
  --header 'Accept: application/json'

Reads your token from $MOTHERSHIP_API_TOKEN

Response

{

: {

: [

{

: "3f1c2a9e-5b7d-4e8a-9c61-2d4f8b0e7a15",

: "logistics@example.com",

: "Dana",

: "Reyes",

: "manager",

: "2026-03-19T17:00:00.000Z",

: true

}

: 1,

: 25,

: 1,

: true

}

Hover a key to see what it means. Click it to jump to the field.

Authorization

Authorization: Bearer <token>

Your sandbox API token. See Authentication.

Query parameters

pageinteger
Page to return, starting at 1
Defaults to 1min 1
perPageinteger
Maximum number of pending invites returned for each page
Defaults to 25min 1max 100

Responses

- dataobjectRequired
  resultsarray of objectsRequired
  pageintegerRequired
  Current page of pending invites
  min 1
  perPageintegerRequired
  Maximum number of pending invites returned for each page
  min 1
  totalintegerRequired
  Number of pending invites across every page
  min 0
  hasMorebooleanRequired
  True if more pending invites can be fetched from a subsequent page

What's next

DELRevoke a pending invite

Revoke an invite by its id.