get-profile-image

Method: GET
Path: /auth/user/{id}/profile-image

Tags: Auth

Summary

Retrieve a profile image

Description

Retrieve user profile image API streamlines the process of retriving profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.

Storefront SDK Usage

SDK Method: sdk.auth.getProfileImage()

Example:

// Get user's profile image URL
const { data, error } = await sdk.auth.getProfileImage({
  id: "01H9XYZ12345USERID"
});

if (error) {
  console.error("Failed to get profile image:", error.message);
} else {
  console.log("Profile image URL:", data.profile_image_url);
}

TypeScript Definition

"get-profile-image": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description user ID */
                id: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        /** @description A descriptive message confirming the success or failure of the retrieve operation. */
                        message: string;
                        /** @description Indicates whether the request was successful or failure (true for success, false for failure). */
                        success: boolean;
                        /** @description An object containing the response content. */
                        content: {
                            /** @description A string representing the URL to a profile image. */
                            profile_image_url: string;
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• id (path): user ID

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Auth"
  ],
  "operationId": "get-profile-image",
  "summary": "Retrieve a profile image",
  "description": "Retrieve user profile image API streamlines the process of retriving profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/get-profile-image",
    "description": "API reference for the get-profile-image operation"
  },
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "user ID",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "description": "A descriptive message confirming the success or failure of the retrieve operation.",
                "type": "string"
              },
              "success": {
                "description": "Indicates whether the request was successful or failure (true for success, false for failure).",
                "type": "boolean"
              },
              "content": {
                "description": "An object containing the response content.",
                "properties": {
                  "profile_image_url": {
                    "description": "A string representing the URL to a profile image.",
                    "type": "string"
                  }
                },
                "required": [
                  "profile_image_url"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "auth",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "getProfileImage"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions