Get all users in your organization

GET 
/v1/users

This route allows you to fetch all of the users in your Port organization.

To learn more about users, check out the documentation.

Request

Query Parameters

fields string[]

Possible values: [id, email, firstName, lastName, picture, status, type, providers, createdAt, updatedAt, teams.name, teams.provider, teams.createdAt, teams.updatedAt, roles.name, roles.description, roles.isAdmin, roles.protected, roles.createdAt, roles.updatedAt]

The fields you want to fetch for each user. If used, only the specified fields will be included in the response.

Responses

200

Retrieved successfully.

application/json

Schema

Schema

okanyrequired

Possible values: [true]

users

object[]

required

Array [

emailstring

firstNamestring

lastNamestring

picturestring

statusstring

idstring

typestring

providersstring[]

createdAtdate-time

updatedAtdate-time

orgs

object[]

Array [

idstringrequired

]

teamsstring[]

roles

object[]

Array [

namestringrequired

]

]

Example (from schema)

{
  "ok": true,
  "users": [
    {
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "picture": "string",
      "status": "string",
      "id": "string",
      "type": "string",
      "providers": [
        "string"
      ],
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "orgs": [
        {
          "id": "string"
        }
      ],
      "teams": [
        "string"
      ],
      "roles": [
        {
          "name": "string"
        }
      ]
    }
  ]
}