---
updatedAt: 2026-05-27T00:00:01.000Z
agentTools:
  projectIndex: https://docs.userback.io/llms.txt
---

# List available members

Lists available Members

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "HTTPError": {
        "description": "Standard HTTP Error Response",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message",
            "maxLength": 255,
            "pattern": ".*"
          },
          "status": {
            "type": "number",
            "format": "double",
            "description": "The status code of the error",
            "maximum": 600
          },
          "details": {
            "properties": {},
            "additionalProperties": {
              "properties": {
                "value": {
                  "description": "The error value",
                  "pattern": ".*",
                  "maxLength": 1000
                },
                "message": {
                  "type": "string",
                  "description": "The error message",
                  "maxLength": 255,
                  "pattern": ".*"
                }
              },
              "required": [
                "message"
              ],
              "type": "object"
            },
            "type": "object",
            "description": "If a validation error occurs, this will contain the details of the validation errors"
          }
        },
        "required": [
          "message",
          "status"
        ],
        "type": "object",
        "additionalProperties": false
      },
      "ID": {
        "type": "integer",
        "format": "int32",
        "example": 4455,
        "description": "ID is a generic type that is used to represent a unique identifier",
        "minimum": 0,
        "maximum": 2147483647
      },
      "MemberRole": {
        "description": "The role of the user.",
        "enum": [
          "Admin",
          "Collaborator",
          "Client",
          "ExternalUser"
        ],
        "type": "string"
      },
      "BaseMember": {
        "properties": {
          "id": {
            "$ref": "#/components/schemas/ID",
            "description": "The ID of the Member."
          },
          "userId": {
            "$ref": "#/components/schemas/ID",
            "description": "The ID of the User.\n\nA User ID is consistent across all Project and Workspace Memberships."
          },
          "name": {
            "type": "string",
            "description": "The name of the user.",
            "maxLength": 255,
            "minLength": 1,
            "pattern": ".*"
          },
          "email": {
            "type": "string",
            "description": "The email address of the user.",
            "format": "email",
            "maxLength": 255
          },
          "avatar": {
            "type": "string",
            "description": "The avatar URL of the user.",
            "format": "uri",
            "maxLength": 65535
          },
          "role": {
            "$ref": "#/components/schemas/MemberRole",
            "description": "The assigned role of the user."
          },
          "isDisabled": {
            "type": "boolean",
            "description": "If true, the member has been disabled and cannot login."
          }
        },
        "required": [
          "id",
          "userId",
          "name",
          "email",
          "role",
          "isDisabled"
        ],
        "type": "object",
        "additionalProperties": false
      },
      "PAGE_NUM": {
        "type": "integer",
        "format": "int32",
        "default": 1,
        "description": "Page number - used for pagination",
        "minimum": 1,
        "maximum": 2147483647
      },
      "PAGE_LIMIT": {
        "type": "integer",
        "format": "int32",
        "default": 25,
        "description": "Page limit - used to limit the result set to a number of records per page",
        "minimum": 1,
        "maximum": 50
      },
      "SORT": {
        "type": "string",
        "description": "Allows to sort the results by single field",
        "pattern": "^[a-zA-Z0-9_]+,(asc|desc)$",
        "minLength": 4,
        "maxLength": 255
      },
      "FILTER": {
        "type": "string",
        "description": "Allows filtering results using odata filter syntax",
        "pattern": ".*",
        "minLength": 1,
        "maxLength": 1000
      },
      "MemberListResponse": {
        "properties": {
          "_links": {
            "properties": {
              "previous": {
                "type": "string",
                "description": "When using pagination, The URI link to the previous page of results",
                "format": "uri",
                "maxLength": 2048
              },
              "next": {
                "type": "string",
                "description": "When using pagination, The URI link to the next page of results",
                "format": "uri",
                "maxLength": 2048
              },
              "last": {
                "type": "string",
                "description": "When using pagination, The URI link to the last page of results",
                "format": "uri",
                "maxLength": 2048
              },
              "first": {
                "type": "string",
                "description": "When using pagination, the URI link to the first page of results",
                "format": "uri",
                "maxLength": 2048
              },
              "self": {
                "type": "string",
                "description": "The URI link to the current resource",
                "format": "uri",
                "maxLength": 2048
              }
            },
            "required": [
              "self"
            ],
            "type": "object",
            "description": "A collection of Hypermedia Application Language (HATEOS) links"
          },
          "_pagination": {
            "properties": {
              "totalPages": {
                "type": "integer",
                "format": "int32",
                "description": "Total pages available",
                "minimum": 0,
                "maximum": 2147483647
              },
              "totalRecords": {
                "type": "integer",
                "format": "int32",
                "description": "Total results available",
                "minimum": 1,
                "maximum": 2147483647
              },
              "pageSize": {
                "type": "integer",
                "format": "int32",
                "description": "Page size",
                "minimum": 1,
                "maximum": 100
              },
              "records": {
                "type": "integer",
                "format": "int32",
                "description": "The count of records returned in the current page",
                "minimum": 0,
                "maximum": 100
              },
              "pageNumber": {
                "type": "integer",
                "format": "int32",
                "description": "Current pagination page number",
                "minimum": 1,
                "maximum": 2147483647
              }
            },
            "required": [
              "totalPages",
              "totalRecords",
              "pageSize",
              "records",
              "pageNumber"
            ],
            "type": "object",
            "description": "Pagination metadata"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/BaseMember"
            },
            "type": "array",
            "description": "An array of Feedback objects returned by the API",
            "maxItems": 100
          }
        },
        "required": [
          "_links",
          "_pagination",
          "data"
        ],
        "type": "object",
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "info": {
    "title": "Userback REST API",
    "version": "1.0.0",
    "description": "Userback REST API",
    "license": {
      "name": " "
    },
    "contact": {
      "name": "Userback Support",
      "email": "support@userback.io",
      "url": "https://support.userback.io/"
    }
  },
  "openapi": "3.0.0",
  "paths": {
    "/member": {
      "get": {
        "operationId": "ListMembers",
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MemberListResponse"
                }
              }
            }
          },
          "401": {
            "description": "Not Authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            }
          },
          "500": {
            "description": "Interal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPError"
                }
              }
            }
          }
        },
        "description": "Lists available Members",
        "summary": "List available members",
        "tags": [
          "Member"
        ],
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/PAGE_NUM"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/PAGE_LIMIT"
            }
          },
          {
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/SORT"
            }
          },
          {
            "in": "query",
            "name": "filter",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/FILTER"
            }
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://rest.userback.io/1.0",
      "description": "Product Server"
    }
  ]
}
```