---
updatedAt: 2026-04-23T05:40:30.000Z
---

# Creates a user list

Creates a User List with the specified details. The parameters field must conform to the QueryBuilder format. Every rule id must be one the filter engine recognises (see POST /users/search for the list); unknown ids return 422 instead of being silently ignored. A "list" rule may only reference saved lists in your organization.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "API V1",
    "version": "v1"
  },
  "paths": {
    "/user_lists": {
      "post": {
        "summary": "Creates a user list",
        "tags": [
          "User Lists"
        ],
        "description": "Creates a User List with the specified details. The parameters field must conform to the QueryBuilder format. Every rule id must be one the filter engine recognises (see POST /users/search for the list); unknown ids return 422 instead of being silently ignored. A \"list\" rule may only reference saved lists in your organization.",
        "parameters": [],
        "responses": {
          "201": {
            "description": "user list created"
          },
          "422": {
            "description": "unprocessable entity"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Name of the user list",
                    "nullable": false
                  },
                  "scope_id": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Identifier for the scope",
                    "nullable": false
                  },
                  "scope_type": {
                    "type": "string",
                    "description": "Type of the scope",
                    "nullable": false,
                    "enum": [
                      "Organization",
                      "Chapter"
                    ]
                  },
                  "event_id": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Identifier for the associated event, if applicable",
                    "nullable": true
                  },
                  "user_id": {
                    "type": "integer",
                    "format": "int64",
                    "description": "Identifier for the associated user",
                    "nullable": true
                  },
                  "parameters": {
                    "type": "object",
                    "description": "Parameters for filtering users in QueryBuilder format",
                    "properties": {
                      "condition": {
                        "type": "string",
                        "enum": [
                          "AND",
                          "OR"
                        ],
                        "description": "Top-level condition for the rules"
                      },
                      "valid": {
                        "type": "boolean",
                        "description": "Indicates if the rule set is valid"
                      },
                      "rules": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Field identifier"
                            },
                            "type": {
                              "type": "string",
                              "description": "Data type of the field"
                            },
                            "operator": {
                              "type": "string",
                              "description": "Comparison operator"
                            },
                            "value": {
                              "oneOf": [
                                {
                                  "type": "string"
                                },
                                {
                                  "type": "number"
                                },
                                {
                                  "type": "boolean"
                                },
                                {
                                  "type": "array",
                                  "items": {
                                    "oneOf": [
                                      {
                                        "type": "string"
                                      },
                                      {
                                        "type": "number"
                                      },
                                      {
                                        "type": "boolean"
                                      }
                                    ]
                                  }
                                }
                              ],
                              "description": "Value or values to compare against"
                            }
                          }
                        }
                      }
                    },
                    "example": {
                      "rules": [
                        {
                          "id": "time.account_created",
                          "type": "date",
                          "value": [
                            "2023-10-23",
                            "2024-07-25"
                          ],
                          "operator": "between"
                        }
                      ],
                      "valid": true,
                      "condition": "AND"
                    }
                  }
                },
                "required": [
                  "name",
                  "scope_id",
                  "scope_type",
                  "parameters"
                ]
              }
            }
          },
          "required": true,
          "description": "Data containing user list information"
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.solidarity.tech/v1",
      "variables": {
        "defaultHost": {
          "default": "api.solidarity.tech/v1"
        }
      }
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}
```