> ## Documentation Index
> Fetch the complete documentation index at: https://sleekplan.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve an end-user



## OpenAPI

````yaml /api/openapi.yaml get /user/{userid}
openapi: 3.1.0
info:
  title: Sleekplan API
  version: '1.0'
  description: >-
    The Sleekplan API is organized around REST. It has predictable
    resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded
    responses, and uses standard HTTP response codes and authentication.


    Use the Sleekplan API for operations within your workspace — read, create,
    update, or delete posts, comments, changelog updates, users, and more. The
    API key you use to authenticate the request determines what you can access.


    ## Rate limits


    Sleekplan enforces a multi-level rate limit based on client IP and
    authenticated user. If you exceed the limit you receive a `429 Too Many
    Requests` response.


    ## Authentication


    The API uses API key authentication. Get your key from **Settings →
    Developer** in the Sleekplan dashboard. Three ways to pass it:


    - **Basic auth** — `-u YOUR_API_KEY:` (note the trailing colon — no
    password)

    - **Bearer token** — `Authorization: Bearer YOUR_API_KEY`

    - **Query parameter** — `?api_key=YOUR_API_KEY`


    All requests must be HTTPS. Treat your API key as a secret — never commit it
    or expose it client-side.


    ```sh

    curl https://api.sleekplan.com/v1/posts \
      -u YOUR_API_KEY:
    ```


    ## Errors


    Sleekplan uses conventional HTTP status codes. `2xx` indicates success;
    `4xx` indicates a client error (bad parameters, auth, etc.); `5xx` indicates
    a server error.


    Successful responses:


    ```json

    {
      "status": "success",
      "data": { }
    }

    ```


    Error responses:


    ```json

    {
      "status": "error",
      "message": "Error message"
    }

    ```


    | HTTP status | Code | Description |

    |---|---|---|

    | **OK** | 200 | Request succeeded. |

    | **Bad Request** | 400 | Request was malformed or missing a required
    parameter. |

    | **Unauthorized** | 401 | No valid API key provided. |

    | **Request Failed** | 402 | Parameters were valid but the request failed. |

    | **Forbidden** | 403 | API key lacks permission for this request. |

    | **Not Found** | 404 | Requested resource does not exist. |

    | **Too Many Requests** | 429 | Rate limit exceeded. |
  contact:
    url: https://sleekplan.com/contact/
    email: support@sleekplan.com
    name: Sleekplan
  termsOfService: https://sleekplan.com/terms/
servers:
  - url: https://api.sleekplan.com/v1
    description: API Version 1
security:
  - BearerAuth: []
  - BasicAuth: []
  - ApiKeyQuery: []
paths:
  /user/{userid}:
    parameters:
      - name: userid
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - User
      summary: Retrieve an end-user
      operationId: get-user
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  data:
                    $ref: '#/components/schemas/User'
components:
  schemas:
    User:
      type: object
      properties:
        user_id:
          type: integer
        data_id:
          type: string
        admin_id:
          type: integer
        anonymous:
          type: boolean
        data_name:
          type: string
        data_full_name:
          type: string
        data_mail:
          type: string
        data_img:
          type: string
        segments:
          type: array
          items:
            type: string
        data:
          type: object
        data_system:
          type: object
          properties:
            ip:
              type: string
            lat:
              type: string
            lng:
              type: string
            city:
              type: string
            browser:
              type: string
            country:
              type: string
            platform:
              type: string
            timezone:
              type: string
            continent:
              type: string
            user_agent:
              type: string
            currency_code:
              type: string
            browser_version:
              type: string
            currency_symbol:
              type: string
        stats_feedback:
          type: integer
        stats_votes:
          type: integer
        stats_comments:
          type: integer
        stats_satisfaction:
          type: integer
        stats_promoter:
          type: integer
        notify:
          type: integer
        notify_settings:
          type: object
          properties:
            mention:
              type: boolean
            changelog:
              type: boolean
            subscribed:
              type: boolean
        weight:
          type: integer
        created:
          type: string
        updated:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
    BasicAuth:
      type: http
      scheme: basic
    ApiKeyQuery:
      type: apiKey
      in: query
      name: api_key

````