Skip to content

List team members

Open .md

GET/v1/api/store/{team_slug}/setting/user

v1Operation ID v1_public_user_index

Returns everyone on the team: name, email, permission group (roles), whether they are the owner, and when they last signed in.

Use the id wherever a request asks for a user, for example to assign people to a job, task or sales order. People who were invited but haven't joined yet are in the invitations list instead.

Permission

Any member of the team, whatever their role. This is wider than the web app, whose Settings pages need Manage Settings: on the API only changes need it.

Path parameters

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

  • dataarray of objectsrequired
    Fields of each item (8)
    • avatar_urlstring | nullrequired
    • emailstringrequired
    • idstringrequired
    • is_ownerbooleanrequired

      True for the team owner. There is exactly one.

    • last_login_atstring (date-time) | nullrequired

      Null when they never signed in.

    • namestringrequired
    • rolesarray of objectsrequired

      Their permission group on this team.

      Fields of each item (2)
      • idstringrequired
      • namestringrequired
    • timezonestring | nullrequired
  • statusintegerrequired
  • successbooleanrequired

Errors

  • 401The API key is missing or wrong (unauthenticated).

  • 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  • 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.