DummyJSON

https://dummyjson.com/docs
Admin
DummyJSON is a free REST API that provides dummy JSON data for products, carts, users, posts, todos,...
Tokens:19,235
Snippets:227
Trust Score:9.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /recipes/tags

Source: https://dummyjson.com/docs/recipes

Retrieve all available recipe tags.

```APIDOC
## GET /recipes/tags

### Description
Retrieve a list of all available recipe tags.

### Method
GET

### Endpoint
https://dummyjson.com/recipes/tags

### Response
#### Success Response (200)
- **tags** (array) - List of tag strings.
```

--------------------------------

### GET /todos/random

Source: https://dummyjson.com/docs/todos

Retrieve a random to-do item.

```APIDOC
## GET /todos/random

### Description
Retrieve a random to-do item. Optionally specify a count to retrieve multiple random items.

### Method
GET

### Endpoint
https://dummyjson.com/todos/random

### Parameters
#### Path Parameters
- **count** (number) - Optional - Number of random items to return (max 10).
```

--------------------------------

### Get all products

Source: https://dummyjson.com/docs/products

Retrieves a list of products. By default, it returns 30 items.

```javascript
fetch('https://dummyjson.com/products')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### Get a single product

Source: https://dummyjson.com/docs/products

Retrieves details for a specific product by its ID.

```javascript
fetch('https://dummyjson.com/products/1')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### GET /products/search

Source: https://dummyjson.com/docs/products

Searches for products based on a query string.

```APIDOC
## GET /products/search

### Description
Searches for products based on a query string.

### Method
GET

### Endpoint
https://dummyjson.com/products/search

### Query Parameters
- **q** (string) - Required - The search query string

### Response
#### Success Response (200)
- **products** (array) - List of matching products
- **total** (number) - Total number of matching products
```

--------------------------------

### GET /products/category-list

Source: https://dummyjson.com/docs/products

Retrieves a simple list of all product category names.

```APIDOC
## GET /products/category-list

### Description
Retrieves a list of all available product category names.

### Method
GET

### Endpoint
https://dummyjson.com/products/category-list
```

--------------------------------

### GET /test

Source: https://dummyjson.com/docs

A test endpoint to verify connectivity to the DummyJSON service.

```APIDOC
## GET /test

### Description
Verifies if the service is reachable.

### Method
GET

### Endpoint
https://dummyjson.com/test

### Response
#### Success Response (200)
- **status** (string) - The status of the request.
- **method** (string) - The HTTP method used.
```

--------------------------------

### GET /products/{id}

Source: https://dummyjson.com/docs/products

Retrieves details for a single product by its unique identifier.

```APIDOC
## GET /products/{id}

### Description
Retrieves details for a single product by its unique identifier.

### Method
GET

### Endpoint
https://dummyjson.com/products/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique identifier of the product

### Response
#### Success Response (200)
- **product** (object) - The product details
```

--------------------------------

### GET /posts/tags

Source: https://dummyjson.com/docs/posts

Retrieves a list of all available post tags.

```APIDOC
## GET /posts/tags

### Description
Retrieves a list of all available post tags.

### Method
GET

### Endpoint
https://dummyjson.com/posts/tags
```

--------------------------------

### GET /products

Source: https://dummyjson.com/docs/products

Retrieves a list of all products. By default, it returns 30 items, which can be adjusted using pagination parameters.

```APIDOC
## GET /products

### Description
Retrieves a list of all products. By default, it returns 30 items.

### Method
GET

### Endpoint
https://dummyjson.com/products

### Query Parameters
- **limit** (number) - Optional - Number of items to return
- **skip** (number) - Optional - Number of items to skip
- **select** (string) - Optional - Comma-separated values to select specific fields

### Response
#### Success Response (200)
- **products** (array) - List of product objects
- **total** (number) - Total number of products
- **skip** (number) - Number of items skipped
- **limit** (number) - Limit applied to the request
```

--------------------------------

### GET /products

Source: https://dummyjson.com/docs/products

Retrieves a list of products. Supports sorting by field name and order.

```APIDOC
## GET /products

### Description
Retrieves a list of products. You can pass sortBy and order parameters to sort the results.

### Method
GET

### Endpoint
https://dummyjson.com/products

### Parameters
#### Query Parameters
- **sortBy** (string) - Optional - The field name to sort by.
- **order** (string) - Optional - The sort order, either "asc" or "desc".
```

--------------------------------

### GET /carts

Source: https://dummyjson.com/docs/carts

Retrieve a list of all shopping carts.

```APIDOC
## GET /carts

### Description
Retrieves a list of all sample shopping carts.

### Method
GET

### Endpoint
https://dummyjson.com/carts

### Response
#### Success Response (200)
- **carts** (array) - List of cart objects
- **total** (number) - Total number of carts
- **skip** (number) - Number of items skipped
- **limit** (number) - Number of items returned
```

--------------------------------

### GET /todos

Source: https://dummyjson.com/docs/todos

Retrieve a list of all to-do items. Supports pagination using limit and skip parameters.

```APIDOC
## GET /todos

### Description
Retrieve a list of all to-do items. By default, returns 30 items.

### Method
GET

### Endpoint
https://dummyjson.com/todos

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Number of items to return.
- **skip** (number) - Optional - Number of items to skip for pagination.
```

--------------------------------

### GET /products/category/{category}

Source: https://dummyjson.com/docs/products

Retrieves all products belonging to a specific category.

```APIDOC
## GET /products/category/{category}

### Description
Retrieves all products that fall under the specified category.

### Method
GET

### Endpoint
https://dummyjson.com/products/category/{category}

### Parameters
#### Path Parameters
- **category** (string) - Required - The category name to filter by.
```

--------------------------------

### GET /image/{size}/{background}/{color}

Source: https://dummyjson.com/docs/image

Generates a placeholder image with custom background and text colors.

```APIDOC
## GET /image/{size}/{background}/{color}

### Description
Generates a placeholder image with custom background and text colors.

### Method
GET

### Endpoint
https://dummyjson.com/image/{size}/{background}/{color}

### Parameters
#### Path Parameters
- **size** (string) - Required - Image dimensions.
- **background** (string) - Optional - Background color hex code.
- **color** (string) - Optional - Text color hex code.
```

--------------------------------

### GET /products/categories

Source: https://dummyjson.com/docs/products

Retrieves a list of all product categories with their associated metadata.

```APIDOC
## GET /products/categories

### Description
Retrieves a list of all product categories including slug, name, and URL.

### Method
GET

### Endpoint
https://dummyjson.com/products/categories
```

--------------------------------

### GET /posts/tag-list

Source: https://dummyjson.com/docs/posts

Retrieves a list of all available post tags.

```APIDOC
## GET /posts/tag-list

### Description
Retrieves a list of all available post tags.

### Method
GET

### Endpoint
https://dummyjson.com/posts/tag-list

### Response
#### Success Response (200)
- **tags** (array) - List of tag strings
```

--------------------------------

### Get all recipes

Source: https://dummyjson.com/docs/recipes

Retrieves a paginated list of recipes. By default, returns 30 items.

```javascript
fetch('https://dummyjson.com/recipes')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### Get all recipe tags

Source: https://dummyjson.com/docs/recipes

Retrieve a list of all available tags associated with recipes.

```javascript
fetch('https://dummyjson.com/recipes/tags')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### GET /recipes/search

Source: https://dummyjson.com/docs/recipes

Searches for recipes based on a query string.

```APIDOC
## GET /recipes/search

### Description
Searches for recipes that match the provided query string.

### Method
GET

### Endpoint
https://dummyjson.com/recipes/search

### Parameters
#### Query Parameters
- **q** (string) - Required - The search query string
```

--------------------------------

### Get recipes by tag

Source: https://dummyjson.com/docs/recipes

Filter recipes by a specific tag name.

```javascript
fetch('https://dummyjson.com/recipes/tag/Pakistani')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### GET /user/me

Source: https://dummyjson.com/docs/users

Retrieves the profile of the currently authenticated user.

```APIDOC
## GET /user/me

### Description
Retrieves the profile of the currently authenticated user. Requires an access token in the Authorization header or via cookies.

### Method
GET

### Endpoint
https://dummyjson.com/user/me

### Response
#### Success Response (200)
- **id** (number) - User ID
- **firstName** (string) - First name
- **lastName** (string) - Last name
- **email** (string) - Email address
```

--------------------------------

### GET /users/search

Source: https://dummyjson.com/docs/users

Searches for users based on a query string.

```APIDOC
## GET /users/search

### Description
Searches for users based on a query string.

### Method
GET

### Endpoint
https://dummyjson.com/users/search

### Parameters
#### Query Parameters
- **q** (string) - Required - The search query string.
```

--------------------------------

### GET /recipes

Source: https://dummyjson.com/docs/recipes

Retrieve a list of recipes with optional sorting parameters.

```APIDOC
## GET /recipes

### Description
Retrieve a list of recipes. You can pass sortBy and order parameters to sort the results.

### Method
GET

### Endpoint
https://dummyjson.com/recipes

### Parameters
#### Query Parameters
- **sortBy** (string) - Optional - The field name to sort by.
- **order** (string) - Optional - The sort order, either "asc" or "desc".

### Response
#### Success Response (200)
- **recipes** (array) - List of recipe objects.
- **total** (number) - Total number of recipes.
- **skip** (number) - Number of items skipped.
- **limit** (number) - Number of items returned.
```

--------------------------------

### GET /posts/search

Source: https://dummyjson.com/docs/posts

Searches for posts based on a query string.

```APIDOC
## GET /posts/search

### Description
Searches for posts based on a query string.

### Method
GET

### Endpoint
https://dummyjson.com/posts/search

### Query Parameters
- **q** (string) - Required - The search query
```

--------------------------------

### GET /posts/{id}

Source: https://dummyjson.com/docs/posts

Retrieves a single post by its ID.

```APIDOC
## GET /posts/{id}

### Description
Retrieves a single post by its ID.

### Method
GET

### Endpoint
https://dummyjson.com/posts/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the post
```

--------------------------------

### Get all carts

Source: https://dummyjson.com/docs/carts

Retrieves a list of all available shopping carts.

```javascript
fetch('https://dummyjson.com/carts')
.then(res => res.json())
.then(console.log);
```

```json
{
  "carts": [
    {
      "id": 1,
      "products": [
        {
          "id": 144,
          "title": "Cricket Helmet",
          "price": 44.99,
          "quantity": 4,
          "total": 179.96,
          "discountPercentage": 11.47,
          "discountedTotal": 159.32,
          "thumbnail": "https://cdn.dummyjson.com/products/images/sports-accessories/Cricket%20Helmet/thumbnail.png"
        },
        {...}
        // more products
      ],
      "total": 4794.8,
      "discountedTotal": 4288.95,
      "userId": 142,
      "totalProducts": 5,
      "totalQuantity": 20
    },
    {...},
    {...},
    {...}
    // 30 items
  ],
  "total": 50,
  "skip": 0,
  "limit": 30
}
```

--------------------------------

### Cart Object Structure

Source: https://dummyjson.com/docs/carts

Example of the JSON structure returned for a cart, including product details and calculated totals.

```json
{
  "id": 1,
  "products": [
    {
      "id": 1,
      "title": "Essence Mascara Lash Princess",
      "price": 9.99,
      "quantity": 1,
      "total": 9.99,
      "discountPercentage": 7.17,
      "discountedPrice": 9,
      "thumbnail": "https://cdn.dummyjson.com/products/images/beauty/Essence%20Mascara%20Lash%20Princess/thumbnail.png"
    }
    {...}
    // other old products
  ],
  "total": 103784.84, // total was updated
  "discountedTotal": 89695, // discounted total was updated
  "userId": 33,
  "totalProducts": 5, // total products were updated
  "totalQuantity": 16 // total quantity was updated
}
```

--------------------------------

### GET /todos/{id}

Source: https://dummyjson.com/docs/todos

Retrieve a single to-do item by its ID.

```APIDOC
## GET /todos/{id}

### Description
Retrieve a single to-do item by its unique ID.

### Method
GET

### Endpoint
https://dummyjson.com/todos/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the to-do item.
```

--------------------------------

### GET /posts

Source: https://dummyjson.com/docs/posts

Retrieves a list of all posts. By default, returns 30 items.

```APIDOC
## GET /posts

### Description
Retrieves a list of all posts. By default, returns 30 items.

### Method
GET

### Endpoint
https://dummyjson.com/posts

### Query Parameters
- **limit** (number) - Optional - Number of items to return
- **skip** (number) - Optional - Number of items to skip
- **select** (string) - Optional - Comma-separated values to select specific data
- **sortBy** (string) - Optional - Field name to sort by
- **order** (string) - Optional - Sort order, "asc" or "desc"

### Response
#### Success Response (200)
- **posts** (array) - List of post objects
- **total** (number) - Total number of posts
- **skip** (number) - Number of items skipped
- **limit** (number) - Limit applied
```

--------------------------------

### GET /image/{size}

Source: https://dummyjson.com/docs/image

Generates a square placeholder image of the specified size.

```APIDOC
## GET /image/{size}

### Description
Generates a square placeholder image.

### Method
GET

### Endpoint
https://dummyjson.com/image/{size}

### Parameters
#### Path Parameters
- **size** (string) - Required - The size of the square image (e.g., 150).
```

--------------------------------

### GET /recipes/{id}

Source: https://dummyjson.com/docs/recipes

Retrieves the details of a single recipe by its unique identifier.

```APIDOC
## GET /recipes/{id}

### Description
Retrieves the full details of a specific recipe using its ID.

### Method
GET

### Endpoint
https://dummyjson.com/recipes/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique identifier of the recipe
```

--------------------------------

### GET /recipes

Source: https://dummyjson.com/docs/recipes

Retrieves a list of all recipes. By default, it returns 30 items, which can be adjusted using pagination parameters.

```APIDOC
## GET /recipes

### Description
Retrieves a list of all recipes. Supports pagination via limit and skip parameters, and field selection via the select parameter.

### Method
GET

### Endpoint
https://dummyjson.com/recipes

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Number of items to return
- **skip** (number) - Optional - Number of items to skip
- **select** (string) - Optional - Comma-separated list of fields to return

### Response
#### Success Response (200)
- **recipes** (array) - List of recipe objects
- **total** (number) - Total number of recipes available
- **skip** (number) - Number of items skipped
- **limit** (number) - Number of items returned
```

--------------------------------

### GET /users/{id}

Source: https://dummyjson.com/docs/users

Retrieves a single user by their unique identifier.

```APIDOC
## GET /users/{id}

### Description
Retrieves a single user by their unique identifier.

### Method
GET

### Endpoint
https://dummyjson.com/users/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique identifier of the user.
```

--------------------------------

### GET /users/filter

Source: https://dummyjson.com/docs/users

Filters users based on a specific key and value.

```APIDOC
## GET /users/filter

### Description
Filters users based on a specific key and value. Nested keys can be accessed using dot notation.

### Method
GET

### Endpoint
https://dummyjson.com/users/filter

### Parameters
#### Query Parameters
- **key** (string) - Required - The field name to filter by.
- **value** (string) - Required - The value to match.
```

--------------------------------

### GET /posts/user/{id}

Source: https://dummyjson.com/docs/posts

Retrieves all posts created by a specific user.

```APIDOC
## GET /posts/user/{id}

### Description
Retrieves all posts created by a specific user.

### Method
GET

### Endpoint
https://dummyjson.com/posts/user/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the user
```

--------------------------------

### GET /recipes/tag/{tag}

Source: https://dummyjson.com/docs/recipes

Retrieve recipes filtered by a specific tag.

```APIDOC
## GET /recipes/tag/{tag}

### Description
Retrieve recipes that match the specified tag.

### Method
GET

### Endpoint
https://dummyjson.com/recipes/tag/{tag}

### Parameters
#### Path Parameters
- **tag** (string) - Required - The tag to filter by.
```

--------------------------------

### Get a single user

Source: https://dummyjson.com/docs/users

Retrieves a single user object by their ID.

```javascript
fetch('https://dummyjson.com/users/1')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### GET /users

Source: https://dummyjson.com/docs/users

Retrieves a list of all users. By default, it returns 30 items, with support for pagination.

```APIDOC
## GET /users

### Description
Retrieves a list of all users. By default, it returns 30 items, with support for pagination.

### Method
GET

### Endpoint
https://dummyjson.com/users

### Response
#### Success Response (200)
- **users** (array) - List of user objects
- **total** (number) - Total number of users
- **skip** (number) - Number of items skipped
- **limit** (number) - Number of items returned
```

--------------------------------

### GET /auth/me

Source: https://dummyjson.com/docs/auth

Retrieves the profile information of the currently authenticated user.

```APIDOC
## GET /auth/me

### Description
Retrieves the current authenticated user's details using a Bearer token in the Authorization header.

### Method
GET

### Endpoint
https://dummyjson.com/auth/me

### Response
#### Success Response (200)
- **id** (number) - User ID
- **username** (string) - Username
- **email** (string) - User email
- **firstName** (string) - First name
- **lastName** (string) - Last name
- **gender** (string) - Gender
- **image** (string) - Profile image URL
```

--------------------------------

### GET /image/{width}x{height}

Source: https://dummyjson.com/docs/image

Generates a placeholder image with custom dimensions.

```APIDOC
## GET /image/{width}x{height}

### Description
Generates a placeholder image with custom width and height.

### Method
GET

### Endpoint
https://dummyjson.com/image/{width}x{height}

### Parameters
#### Path Parameters
- **width** (integer) - Required - Image width.
- **height** (integer) - Required - Image height.
```

--------------------------------

### Get a single recipe

Source: https://dummyjson.com/docs/recipes

Retrieves details for a specific recipe using its unique ID.

```javascript
fetch('https://dummyjson.com/recipes/1')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### GET /icon/{hash}/{size}

Source: https://dummyjson.com/docs/image

Generates an identicon based on a hash string.

```APIDOC
## GET /icon/{hash}/{size}

### Description
Generates an identicon based on a provided hash.

### Method
GET

### Endpoint
https://dummyjson.com/icon/{hash}/{size}

### Parameters
#### Path Parameters
- **hash** (string) - Required - The hash string for the identicon.
- **size** (integer) - Required - The size of the icon.

#### Query Parameters
- **type** (string) - Optional - Image format (png or svg).
```

--------------------------------

### Paginate todos with limit and skip

Source: https://dummyjson.com/docs/todos

Uses query parameters to control the number of results returned and the starting offset.

```javascript
fetch('https://dummyjson.com/todos?limit=3&skip=10')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### POST /products/add

Source: https://dummyjson.com/docs/products

Simulates adding a new product to the server.

```APIDOC
## POST /products/add

### Description
Simulates a POST request to add a new product. Returns the created product with a new ID.

### Method
POST

### Endpoint
https://dummyjson.com/products/add
```

--------------------------------

### GET /ip

Source: https://dummyjson.com/docs

Retrieves the client's IP address and user agent information.

```APIDOC
## GET /ip

### Description
Returns the IP address and user agent of the requesting client.

### Method
GET

### Endpoint
https://dummyjson.com/ip

### Response
#### Success Response (200)
- **ip** (string) - The client's IP address.
- **userAgent** (string) - The client's user agent string.
```

--------------------------------

### Limit, skip, and select products

Source: https://dummyjson.com/docs/products

Demonstrates pagination using limit and skip parameters, and field selection using the select parameter.

```javascript
fetch('https://dummyjson.com/products?limit=10&skip=10&select=title,price')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### Limit, skip, and select recipes

Source: https://dummyjson.com/docs/recipes

Demonstrates pagination using limit and skip parameters, and field filtering using the select parameter.

```javascript
fetch('https://dummyjson.com/recipes?limit=10&skip=10&select=name,image')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### GET /http/{code}/{optional-message}

Source: https://dummyjson.com/docs/http

Returns a mocked HTTP response with the specified status code and an optional custom message.

```APIDOC
## GET /http/{code}/{optional-message}

### Description
Returns a mocked HTTP response based on the provided status code and an optional custom message.

### Method
GET

### Endpoint
https://dummyjson.com/http/{code}/{optional-message}

### Parameters
#### Path Parameters
- **code** (string) - Required - The HTTP status code to mock.
- **optional-message** (string) - Optional - A custom message to be returned in the response body.

### Response
#### Success Response (200)
- **status** (string) - The HTTP status code returned.
- **message** (string) - The message returned in the response.

### Response Example
{
  "status": "200",
  "message": "OK"
}
```

--------------------------------

### GET /recipes/meal-type/{meal}

Source: https://dummyjson.com/docs/recipes

Retrieve recipes filtered by a specific meal type.

```APIDOC
## GET /recipes/meal-type/{meal}

### Description
Retrieve recipes that match the specified meal type.

### Method
GET

### Endpoint
https://dummyjson.com/recipes/meal-type/{meal}

### Parameters
#### Path Parameters
- **meal** (string) - Required - The meal type to filter by.
```

--------------------------------

### POST /recipes/add

Source: https://dummyjson.com/docs/recipes

Simulate adding a new recipe.

```APIDOC
## POST /recipes/add

### Description
Simulates adding a new recipe and returns the created recipe with a new ID.

### Method
POST

### Endpoint
https://dummyjson.com/recipes/add

### Request Body
- **name** (string) - Required - The name of the recipe.
```

--------------------------------

### GET /posts/tag/{tag}

Source: https://dummyjson.com/docs/posts

Retrieves a list of posts filtered by a specific tag.

```APIDOC
## GET /posts/tag/{tag}

### Description
Retrieves a list of posts filtered by a specific tag.

### Method
GET

### Endpoint
https://dummyjson.com/posts/tag/{tag}

### Parameters
#### Path Parameters
- **tag** (string) - Required - The tag to filter posts by
```

--------------------------------

### GET /quotes

Source: https://dummyjson.com/docs/quotes

Retrieves a list of quotes. By default, returns 30 items.

```APIDOC
## GET /quotes

### Description
Retrieves a paginated list of quotes.

### Method
GET

### Endpoint
https://dummyjson.com/quotes

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Number of items to return (default 30)
- **skip** (number) - Optional - Number of items to skip for pagination

### Response
#### Success Response (200)
- **quotes** (array) - List of quote objects
- **total** (number) - Total number of quotes available
- **skip** (number) - Number of items skipped
- **limit** (number) - Number of items returned
```

--------------------------------

### POST /todos/add

Source: https://dummyjson.com/docs/todos

Simulate adding a new to-do item.

```APIDOC
## POST /todos/add

### Description
Simulates adding a new to-do item and returns the created object with a new ID.

### Method
POST

### Endpoint
https://dummyjson.com/todos/add

### Request Body
- **todo** (string) - Required - The task description.
- **completed** (boolean) - Required - The completion status.
- **userId** (number) - Required - The ID of the user.
```

--------------------------------

### GET /comments

Source: https://dummyjson.com/docs/comments

Retrieve a list of all comments. By default, it returns 30 items.

```APIDOC
## GET /comments

### Description
Retrieve a list of all comments. By default, it returns 30 items.

### Method
GET

### Endpoint
https://dummyjson.com/comments

### Query Parameters
- **limit** (number) - Optional - Number of items to return
- **skip** (number) - Optional - Number of items to skip
- **select** (string) - Optional - Comma-separated values to select specific data

### Response
#### Success Response (200)
- **comments** (array) - List of comment objects
- **total** (number) - Total number of comments
- **skip** (number) - Number of items skipped
- **limit** (number) - Number of items returned
```

--------------------------------

### GET /todos/user/{userId}

Source: https://dummyjson.com/docs/todos

Retrieve all to-do items associated with a specific user ID.

```APIDOC
## GET /todos/user/{userId}

### Description
Retrieve all to-do items belonging to a specific user.

### Method
GET

### Endpoint
https://dummyjson.com/todos/user/{userId}

### Parameters
#### Path Parameters
- **userId** (number) - Required - The ID of the user.
```

--------------------------------

### Get recipes by meal type

Source: https://dummyjson.com/docs/recipes

Filter recipes based on their meal type category.

```javascript
fetch('https://dummyjson.com/recipes/meal-type/snack')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### POST /users/add

Source: https://dummyjson.com/docs/users

Simulates the creation of a new user.

```APIDOC
## POST /users/add

### Description
Simulates adding a new user to the system and returns the created user object with a new ID.

### Method
POST

### Endpoint
https://dummyjson.com/users/add

### Request Body
- **firstName** (string) - Required - User first name
- **lastName** (string) - Required - User last name
- **age** (number) - Required - User age
```

--------------------------------

### Generate TOTP via GET

Source: https://dummyjson.com/docs/tools

Pass the base32 secret key as a query parameter to generate a TOTP code.

```javascript
fetch('https://dummyjson.com/2fa?key=JBSWY3DPEHPK3PXP')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### GET /webhook/{identifier}/requests

Source: https://dummyjson.com/docs/tools

Retrieves all captured requests for a specific webhook.

```APIDOC
## GET /webhook/{identifier}/requests

### Description
Polls the endpoint to retrieve all requests captured by the webhook.

### Method
GET

### Endpoint
/webhook/{identifier}/requests

### Parameters
#### Path Parameters
- **identifier** (string) - Required - The unique webhook identifier.

### Response
#### Success Response (200)
- **requests** (array) - List of captured request objects.
```

--------------------------------

### Limit and skip users

Source: https://dummyjson.com/docs/users

Demonstrates pagination using limit and skip parameters, and field selection using the select parameter.

```javascript
fetch('https://dummyjson.com/users?limit=5&skip=10&select=firstName,age')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### POST /posts/add

Source: https://dummyjson.com/docs/posts

Simulates adding a new post to the server.

```APIDOC
## POST /posts/add

### Description
Simulates adding a new post to the server and returns the created post object.

### Method
POST

### Endpoint
https://dummyjson.com/posts/add

### Request Body
- **title** (string) - Required - The title of the post
- **userId** (number) - Required - The ID of the user creating the post
```

--------------------------------

### Limit and skip quotes

Source: https://dummyjson.com/docs/quotes

Applies pagination parameters to control the number of returned items and the starting offset.

```javascript
fetch('https://dummyjson.com/quotes?limit=3&skip=10')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### GET /users/{id}/todos

Source: https://dummyjson.com/docs/users

Retrieves a list of todos associated with a specific user ID.

```APIDOC
## GET /users/{id}/todos

### Description
Retrieves all todo items assigned to the user with the specified ID.

### Method
GET

### Endpoint
https://dummyjson.com/users/{id}/todos

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the user.
```

--------------------------------

### POST /carts/add

Source: https://dummyjson.com/docs/carts

Simulate adding a new shopping cart.

```APIDOC
## POST /carts/add

### Description
Simulates the creation of a new shopping cart. Returns the created cart object with a new ID.

### Method
POST

### Endpoint
https://dummyjson.com/carts/add

### Request Body
- **userId** (number) - Required - The ID of the user
- **products** (array) - Required - Array of objects containing productId and quantity
```

--------------------------------

### GET /comments/{id}

Source: https://dummyjson.com/docs/comments

Retrieve a single comment by its ID.

```APIDOC
## GET /comments/{id}

### Description
Retrieve a single comment by its ID.

### Method
GET

### Endpoint
https://dummyjson.com/comments/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the comment
```

--------------------------------

### GET /2fa

Source: https://dummyjson.com/docs/tools

Generates a TOTP verification code using a base32 secret key passed as a query parameter.

```APIDOC
## GET /2fa

### Description
Generates a TOTP verification code.

### Method
GET

### Endpoint
/2fa

### Parameters
#### Query Parameters
- **key** (string) - Required - The base32 secret key or otpauth URI.

### Response
#### Success Response (200)
- **totp** (string) - The generated TOTP code.
- **expiresIn** (number) - Seconds until expiration.
- **period** (number) - Validity period in seconds.
```

--------------------------------

### Add a new recipe

Source: https://dummyjson.com/docs/recipes

Simulates a POST request to create a new recipe. Changes are not persisted on the server.

```javascript
fetch('https://dummyjson.com/recipes/add', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    name: 'Tasty Pizza'
    /* other recipe data */
  })
})
.then(res => res.json())
.then(console.log);
```

--------------------------------

### Fetch all todos

Source: https://dummyjson.com/docs/todos

Retrieves a list of 30 todos by default.

```javascript
fetch('https://dummyjson.com/todos')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### Add a new product

Source: https://dummyjson.com/docs/products

Simulates a POST request to create a new product. The operation does not persist data to the server.

```javascript
fetch('https://dummyjson.com/products/add', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    title: 'BMW Pencil',
    /* other product data */
  })
})
.then(res => res.json())
.then(console.log);
```

--------------------------------

### POST /webhook/create

Source: https://dummyjson.com/docs/tools

Creates a temporary webhook URL to capture incoming HTTP requests.

```APIDOC
## POST /webhook/create

### Description
Creates a temporary webhook URL for capturing and inspecting HTTP requests.

### Method
POST

### Endpoint
/webhook/create

### Response
#### Success Response (200)
- **identifier** (string) - Unique webhook ID.
- **url** (string) - The webhook URL.
- **expiresAt** (string) - Expiration timestamp.
```

--------------------------------

### Get a single cart

Source: https://dummyjson.com/docs/carts

Retrieves details for a specific cart by its ID.

```javascript
fetch('https://dummyjson.com/carts/1')
.then(res => res.json())
.then(console.log);
```

```json
{
  "id": 1,
  "products": [
    {
      "id": 144,
      "title": "Cricket Helmet",
      "price": 44.99,
      "quantity": 4,
      "total": 179.96,
      "discountPercentage": 11.47,
      "discountedTotal": 159.32,
      "thumbnail": "https://cdn.dummyjson.com/products/images/sports-accessories/Cricket%20Helmet/thumbnail.png"
    },
    {...}
    // more products
  ],
  "total": 4794.8,
  "discountedTotal": 4288.95,
  "userId": 142,
  "totalProducts": 5,
  "totalQuantity": 20
}
```

--------------------------------

### PUT /recipes/{id}

Source: https://dummyjson.com/docs/recipes

Simulate updating an existing recipe.

```APIDOC
## PUT /recipes/{id}

### Description
Simulates updating an existing recipe and returns the updated recipe data.

### Method
PUT

### Endpoint
https://dummyjson.com/recipes/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the recipe to update.

### Request Body
- **name** (string) - Optional - The new name for the recipe.
```

--------------------------------

### DELETE /products/{id}

Source: https://dummyjson.com/docs/products

Simulates deleting an existing product.

```APIDOC
## DELETE /products/{id}

### Description
Simulates a DELETE request to remove a product. Returns the deleted product with deletion metadata.

### Method
DELETE

### Endpoint
https://dummyjson.com/products/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the product to delete.
```

--------------------------------

### Generate image with different formats

Source: https://dummyjson.com/docs/image

Fetches a placeholder image in a specific format like webp, png, or jpeg.

```javascript
// https://dummyjson.com/image/SIZE/BACKGROUND/COLOR
fetch('https://dummyjson.com/image/400x200?type=webp&text=I+am+a+webp+image')
.then(response => response.blob()) // Convert response to blob
.then(blob => {
  console.log('Fetched image blob:', blob);
})
// Blob {size: SIZE, type: 'image/webp'}
```

--------------------------------

### POST /comments/add

Source: https://dummyjson.com/docs/comments

Simulate adding a new comment.

```APIDOC
## POST /comments/add

### Description
Simulate adding a new comment. Returns the created comment with a new ID.

### Method
POST

### Endpoint
https://dummyjson.com/comments/add

### Request Body
- **body** (string) - Required - The comment text
- **postId** (number) - Required - The ID of the post
- **userId** (number) - Required - The ID of the user
```

--------------------------------

### GET /quotes/random

Source: https://dummyjson.com/docs/quotes

Retrieves a random quote or a set of random quotes.

```APIDOC
## GET /quotes/random

### Description
Retrieves a random quote. Optionally, a count can be specified to retrieve multiple random quotes.

### Method
GET

### Endpoint
https://dummyjson.com/quotes/random

### Parameters
#### Path Parameters
- **count** (number) - Optional - Number of random quotes to return (max 10)
```

--------------------------------

### Generate image with custom text

Source: https://dummyjson.com/docs/image

Fetches a placeholder image with custom text and color styling.

```javascript
// https://dummyjson.com/image/SIZE/?text=TEXT
fetch('https://dummyjson.com/image/400x200/008080/ffffff?text=Hello+Peter')
.then(response => response.blob()) // Convert response to blob
.then(blob => {
  console.log('Fetched image blob:', blob);
})
// Blob {size: SIZE, type: 'image/png'}
```

--------------------------------

### GET /quotes/{id}

Source: https://dummyjson.com/docs/quotes

Retrieves a single quote by its unique identifier.

```APIDOC
## GET /quotes/{id}

### Description
Retrieves a single quote based on the provided ID.

### Method
GET

### Endpoint
https://dummyjson.com/quotes/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique identifier of the quote

### Response
#### Success Response (200)
- **id** (number) - Quote ID
- **quote** (string) - The quote text
- **author** (string) - The author of the quote
```

--------------------------------

### GET /users/{id}/carts

Source: https://dummyjson.com/docs/users

Retrieves the carts associated with a specific user.

```APIDOC
## GET /users/{id}/carts

### Description
Retrieves the carts associated with a specific user.

### Method
GET

### Endpoint
https://dummyjson.com/users/{id}/carts

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique identifier of the user.
```

--------------------------------

### GET /posts/{id}/comments

Source: https://dummyjson.com/docs/posts

Retrieves all comments associated with a specific post.

```APIDOC
## GET /posts/{id}/comments

### Description
Retrieves all comments associated with a specific post.

### Method
GET

### Endpoint
https://dummyjson.com/posts/{id}/comments

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the post
```

--------------------------------

### Retrieve all product categories

Source: https://dummyjson.com/docs/products

Fetches a list of all product categories with their associated metadata.

```javascript
fetch('https://dummyjson.com/products/categories')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### Retrieve product category list

Source: https://dummyjson.com/docs/products

Fetches a simple array of category names.

```javascript
fetch('https://dummyjson.com/products/category-list')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### Fetch all users

Source: https://dummyjson.com/docs/users

Retrieves a paginated list of users. By default, it returns 30 items.

```javascript
fetch('https://dummyjson.com/users')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### POST /c/generate

Source: https://dummyjson.com/docs/tools

Creates a custom mock REST API endpoint.

```APIDOC
## POST /c/generate

### Description
Creates a unique URL that returns a custom JSON response for a specified HTTP method.

### Method
POST

### Endpoint
/c/generate

### Request Body
- **json** (object) - Required - The JSON body to return.
- **method** (string) - Required - The HTTP method the generated endpoint should respond to.

### Response
#### Success Response (200)
- **url** (string) - The unique URL for the custom API.
```

--------------------------------

### GET /carts/user/{userId}

Source: https://dummyjson.com/docs/carts

Retrieve all shopping carts associated with a specific user.

```APIDOC
## GET /carts/user/{userId}

### Description
Retrieves all shopping carts belonging to a specific user.

### Method
GET

### Endpoint
https://dummyjson.com/carts/user/{userId}

### Parameters
#### Path Parameters
- **userId** (number) - Required - The ID of the user
```

--------------------------------

### PUT/PATCH /products/{id}

Source: https://dummyjson.com/docs/products

Simulates updating an existing product.

```APIDOC
## PUT /products/{id}

### Description
Simulates a PUT or PATCH request to update an existing product. Returns the updated product data.

### Method
PUT/PATCH

### Endpoint
https://dummyjson.com/products/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the product to update.
```

--------------------------------

### GET /carts/{id}

Source: https://dummyjson.com/docs/carts

Retrieve details for a specific shopping cart by its ID.

```APIDOC
## GET /carts/{id}

### Description
Retrieves the details of a single shopping cart by its unique ID.

### Method
GET

### Endpoint
https://dummyjson.com/carts/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the cart to retrieve
```

--------------------------------

### Retrieve products by category

Source: https://dummyjson.com/docs/products

Fetches all products belonging to a specific category.

```javascript
fetch('https://dummyjson.com/products/category/smartphones')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### Get carts by a user

Source: https://dummyjson.com/docs/carts

Retrieves all carts associated with a specific user ID.

```javascript
// getting carts by user with id 5
fetch('https://dummyjson.com/carts/user/5')
.then(res => res.json())
.then(console.log);
```

```json
{
  "carts": [
    {
      "id": 19,
      "products": [
        {
          "id": 144,
          "title": "Cricket Helmet",
          "price": 44.99,
          "quantity": 4,
          "total": 179.96,
          "discountPercentage": 11.47,
          "discountedTotal": 159.32,
          "thumbnail": "https://cdn.dummyjson.com/products/images/sports-accessories/Cricket%20Helmet/thumbnail.png"
        },
        {...}
        // more products
      ],
      "total": 2492,
      "discountedTotal": 2140,
      "userId": 5, // user id is 5
      "totalProducts": 5,
      "totalQuantity": 14
    }
  ],
  "total": 1,
  "skip": 0,
  "limit": 1
}
```

--------------------------------

### Search products

Source: https://dummyjson.com/docs/products

Searches for products matching a query string.

```javascript
fetch('https://dummyjson.com/products/search?q=phone')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### Retrieve all posts

Source: https://dummyjson.com/docs/posts

Fetches a paginated list of posts. By default, returns 30 items.

```javascript
fetch('https://dummyjson.com/posts')
.then(res => res.json())
.then(console.log);
```

--------------------------------

### GET /comments/post/{id}

Source: https://dummyjson.com/docs/comments

Retrieve all comments associated with a specific post ID.

```APIDOC
## GET /comments/post/{id}

### Description
Retrieve all comments associated with a specific post ID.

### Method
GET

### Endpoint
https://dummyjson.com/comments/post/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the post
```

--------------------------------

### Login User and Retrieve Tokens

Source: https://dummyjson.com/docs/auth

Authenticates a user using credentials and returns access and refresh tokens. Tokens are provided in the response body and set as cookies.

```javascript
fetch('https://dummyjson.com/auth/login', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    
    username: 'emilys',
    password: 'emilyspass',
    expiresInMins: 30, // optional, defaults to 60
  }),
  credentials: 'include' // Include cookies (e.g., accessToken) in the request
})
.then(res => res.json())
.then(console.log);
```

--------------------------------

### PUT /todos/{id}

Source: https://dummyjson.com/docs/todos

Simulate updating an existing to-do item.

```APIDOC
## PUT /todos/{id}

### Description
Simulates updating an existing to-do item and returns the modified object.

### Method
PUT

### Endpoint
https://dummyjson.com/todos/{id}

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the to-do item to update.

### Request Body
- **completed** (boolean) - Optional - The updated completion status.
```

--------------------------------

### Generate image with custom colors

Source: https://dummyjson.com/docs/image

Fetches a placeholder image with a specific background color.

```javascript
// https://dummyjson.com/image/SIZE/BACKGROUND/COLOR
fetch('https://dummyjson.com/image/400x200/282828')
.then(response => response.blob()) // Convert response to blob
.then(blob => {
  console.log('Fetched image blob:', blob);
})
// Blob {size: SIZE, type: 'image/png'}
```

--------------------------------

### Add a new user

Source: https://dummyjson.com/docs/users

Simulates a POST request to create a new user. This operation does not persist data on the server.

```javascript
fetch('https://dummyjson.com/users/add', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    firstName: 'Muhammad',
    lastName: 'Ovi',
    age: 250,
    /* other user data */
  })
})
.then(res => res.json())
.then(console.log);
```

--------------------------------

### Create Webhook Endpoint

Source: https://dummyjson.com/docs/tools

Generate a temporary URL to capture and inspect incoming HTTP requests.

```javascript
fetch('https://dummyjson.com/webhook/create', {
  method: 'POST'
})
.then(res => res.json())
.then(console.log);
```

--------------------------------

### GET /users/{id}/posts

Source: https://dummyjson.com/docs/users

Retrieves a list of posts associated with a specific user ID.

```APIDOC
## GET /users/{id}/posts

### Description
Retrieves all posts created by the user with the specified ID.

### Method
GET

### Endpoint
https://dummyjson.com/users/{id}/posts

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the user.
```

--------------------------------

### Retrieve Client IP Address

Source: https://dummyjson.com/docs

Fetch the client's IP address and user agent information.

```javascript
// GET
fetch('https://dummyjson.com/ip')
.then(res => res.json())
.then(console.log);

/* { ip: '127.0.0.1', userAgent: 'Mozilla/5.0 ...' } */
```
Tokens:
Raw