Skip to content
MothershipDevelopers

API referenceUsers

List users

Lists the active users in your organization, sorted by first name, one page at a time. Suspended users are left out. Requires the organization:user.read permission.

GET/users
Environment
https://sandbox.api.mothership.com/beta
curl --request GET \
  --url 'https://sandbox.api.mothership.com/beta/users' \
  --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",
: "owner",
: "active"
}
],
: 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 users returned for each page

    Defaults to 25min 1max 100

Responses

    • dataobjectRequired
      • resultsarray of objectsRequired
      • pageintegerRequired

        Current page of users

        min 1
      • perPageintegerRequired

        Maximum number of users returned for each page

        min 1
      • totalintegerRequired

        Number of users across every page

        min 0
      • hasMorebooleanRequired

        True if more users can be fetched from a subsequent page

What's next

POSTSuspend a user

Suspend a user by their id.