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

# Retrieves all custom user properties

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "API V1",
    "version": "v1"
  },
  "paths": {
    "/custom_user_properties": {
      "get": {
        "summary": "Retrieves all custom user properties",
        "tags": [
          "Custom User Properties"
        ],
        "parameters": [
          {
            "name": "_limit",
            "in": "query",
            "description": "Limits the number of items returned. Default is 20, maximum is 100.",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 20
            }
          },
          {
            "name": "_offset",
            "in": "query",
            "description": "Number of items to skip before starting to return the results.",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "_since",
            "in": "query",
            "description": "UTC timestamp in seconds since the Unix epoch to filter custom user properties created after this time.",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "scope_id",
            "in": "query",
            "description": "ID of the scope to filter custom user properties by.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "scope_type",
            "in": "query",
            "description": "Type of the scope to filter custom user properties by.",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "Organization",
                "Chapter"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer"
                          },
                          "name": {
                            "type": "string"
                          },
                          "key": {
                            "type": "string"
                          },
                          "field_type": {
                            "type": "string"
                          },
                          "options": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "label": {
                                  "type": "object",
                                  "additionalProperties": {
                                    "type": "string",
                                    "nullable": true
                                  }
                                },
                                "value": {
                                  "type": "string"
                                }
                              }
                            },
                            "nullable": true
                          },
                          "scope_id": {
                            "type": "integer"
                          },
                          "scope_type": {
                            "type": "string",
                            "description": "Type of the scope",
                            "nullable": false,
                            "enum": [
                              "Organization",
                              "Chapter"
                            ]
                          }
                        }
                      }
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "total_count": {
                          "type": "integer"
                        },
                        "limit": {
                          "type": "integer"
                        },
                        "offset": {
                          "type": "integer"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.solidarity.tech/v1",
      "variables": {
        "defaultHost": {
          "default": "api.solidarity.tech/v1"
        }
      }
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}
```