Sign in
latestSwagger 2.02026-08-102194011.3 MB

602fc25ddd76

Users V2

List Users V2

List users for an organisation.

get/v2/users

Query parameters

emailstring

Filter by email address

slack_user_idstring

Filter by Slack user ID

page_sizeinteger

Integer number of records to return

afterstring

An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.

Response

OK response.

Example response

{
  "pagination_meta": {
    "after": "01FCNDV6P870EA6S7TK1DSYDG0",
    "page_size": 25
  },
  "users": [
    {
      "base_role": {
        "description": "Elevated permissions for the customer success team.",
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "Customer Success",
        "slug": "customer-success"
      },
      "custom_roles": [
        {
          "description": "Elevated permissions for the customer success team.",
          "id": "01FCNDV6P870EA6S7TK1DSYDG0",
          "name": "Customer Success",
          "slug": "customer-success"
        }
      ],
      "email": "lisa@incident.io",
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "name": "Lisa Karlin Curtis",
      "role": "viewer",
      "slack_user_id": "U02AYNF2XJM"
    }
  ]
}