list-users

restish dci list-users

Returns a list of all users in the organization, including both active users and invited users.

Responses

200 (application/json)

OK - List of users returned.

{
  "type": "object",
  "description": "Response body for the list users endpoint.",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Summary information of a user.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique ID of the user."
          },
          "email": {
            "type": "string",
            "description": "The email address of the user."
          },
          "displayName": {
            "type": "string",
            "description": "The user's display name."
          },
          "firstName": {
            "type": "string",
            "description": "The user's first name."
          },
          "lastName": {
            "type": "string",
            "description": "The user's last name."
          },
          "jobFunction": {
            "type": "string",
            "description": "The user's job function.",
            "enum": [
              "Data Engineer / Data Analysts",
              "Executive Team",
              "Finance / Accounting",
              "Founder",
              "Legal / Purchasing",
              "Management",
              "Sales / Marketing",
              "Software / Ops Engineer"
            ]
          },
          "phone": {
            "type": "string",
            "description": "The user's country code (e.g., +44).",
            "pattern": "^\\+[0-9]+$"
          },
          "phoneExtension": {
            "type": "string",
            "description": "The user's phone extension."
          },
          "language": {
            "type": "string",
            "description": "The user's preferred language.",
            "enum": [
              "en",
              "ja"
            ]
          },
          "roleId": {
            "type": "string",
            "description": "The ID of the user's role."
          },
          "organizationId": {
            "type": "string",
            "description": "The ID of the user's organization."
          },
          "status": {
            "type": "string",
            "description": "The status of the user (active or invited).",
            "enum": [
              "active",
              "invited"
            ]
          }
        }
      }
    },
    "rowCount": {
      "type": "integer",
      "description": "The number of returned records.",
      "format": "int64",
      "example": 5
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: list-users, listusers