Teammates API Reference

Get teammates

Endpoint:

GET /v1/:page_id/team?page=:page&per_page=:per_page

• The default page number is 1.
• The default per_page number is 50 and the maximum is 100 items per page.

Example response

[
  {
    "id": "cm1111x6ofgsd5666mzxcw978qh",
    "user": {
      "id": "cm111114566gsd5666mzxcw978qh",
      "name": "Ali Salah",
      "email": "ali@instatus.com",
      "avatar": "https://res.cloudinary.com/sup/image/upload/v1600287654/avatars/uuhfbauwwv7zjzzejgik.jpg"
    }
  }
]

Add a team member

POST /v1/:page_id/team

Example request

{
  "email": "john@instatus.com"
}

Example response

{
    "id": "cm1111x6ofgsd5666mzxcw978qh",
    "name": null,
    "email": "john@instatus.com",
    "createdAt": "2024-09-30T18:41:35.957Z",
    "updatedAt": "2024-09-30T18:41:35.957Z",
    "avatar": null,
    "phone": null,
    "temp": null,
    "slug": null,
    "usePassword": false,
    "verifyToken": null,
    "use24HourTime": false,
    "enableMagicLinkResendAt": null,
    "oldEmail": null,
    "revokeEmailToken": null,
    "revokeEmailTokenExpiresAt": null,
    "affiliateId": null,
    "affiliateToken": null,
    "use2FA": false,
    "mobileConnectionToken": null,
    "mobileConnectionTokenExpiresAt": null
}

Delete a team member

DELETE /v1/:page_id/team/:member_id

Example response

{
    "memberId": "cm1111x6ofgsd5666mzxcw978qh"
}