Skip to main content

User

Retrieve Organization Users​

GEThttps://api.tapeapp.com/v1/org/user

Retrieve your current organization's users (e.g. the organization with ID 1337):

➡️    Request
curl https://api.tapeapp.com/v1/org/user \
  -u user_key_replace_with_your_api_key:
⬅️    Response
{
  "users": [
    {
      "user_id": 10000,
      "name": "John Doe",
      "org_id": 1337,
      "status": "active",
      "email": "[email protected]",
      "phone": "555 123 456",
      "role": "owner",
      "job_description": "Founder & CEO"
    },
    {
      "user_id": 10001,
      "name": "Zoe Maxwell",
      "org_id": 1337,
      "status": "active",
      "email": "[email protected]",
      "phone": "555 123 457",
      "role": "member",
      "job_description": "Executive"
    }
  ]
}

Add User to Organization​

POSThttps://api.tapeapp.com/v1/org/user

Add a new user to your current organization (e.g. the organization with ID 1337). Include the skip_invitation flag in your request body to skip sending invitation email upon user creation.

➡️    Request
curl -X POST https://api.tapeapp.com/v1/org/user \
  -u user_key_replace_with_your_api_key: \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Roger Sterling",
    "email": "[email protected]",
    "role": "admin",
    "skip_invitation": true
  }'
⬅️    Response
{
    "user_id": 10002,
    "name": "Roger Sterling",
    "org_id": 1337,
    "status": "active",
    "email": "[email protected]",
    "phone": "555 123 458",
    "role": "admin",
    "job_description": "VP"
}
User Organization Role

The role property to create users needs to be one of "admin", "member" and"guest". This corresponds to the user organization roles documented in the help center. Note that adding admin and member users is a billable event. 💲

Resend User invitation email​

POSThttps://api.tapeapp.com/v1/org/user/{userId}/resend-invitation

Resend an invitation email for an organization user. This will be important when skipping invitations during user creation, and allows sending the invitation email at a dedicated point in time later or repetitively.

➡️    Request
curl -X POST https://api.tapeapp.com/v1/org/user/10000/resend-invitation \
  -u user_key_replace_with_your_api_key:
⬅️    Response
{
}

Update or delete users​

Not available

Modifying existing User endpoints are not available yet. Create a community feature request if those are important for your integrations.