JSONPlaceholder

https://jsonplaceholder.typicode.com/
Admin
JSONPlaceholder is a free, fake, and reliable online REST API for testing and prototyping, providing...
Tokens:6,780
Snippets:38
Trust Score:7.9
Update:6 days ago
Show doc for...
Tokens:
Raw
### GET /posts

Source: https://jsonplaceholder.typicode.com/#guide

Fetches a list of all posts. Returns an array of post objects.

```APIDOC
## GET /posts

### Description
Fetches a list of all posts.

### Method
GET

### Endpoint
https://jsonplaceholder.typicode.com/posts

### Request Example
```
fetch('https://jsonplaceholder.typicode.com/posts')
  .then(response => response.json())
  .then(json => console.log(json))
```

### Response
#### Success Response (200)
- **array of posts** - Each post object contains userId, id, title, and body fields.

#### Response Example
```
[
  { "userId": 1, "id": 1, "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", "body": "quia et suscipit…" },
  { "userId": 1, "id": 2, "title": "qui est esse", "body": "est rerum tempore vitae…" },
  // … 100 posts
]
```
```

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

### GET /posts

Source: https://jsonplaceholder.typicode.com/#guide

Retrieves a list of all posts. This endpoint returns an array of post objects.

```APIDOC
## GET /posts

### Description
Retrieves a list of all posts.

### Method
GET

### Endpoint
/posts

### Response
#### Success Response (200)
- **id** (number) - Post ID
- **userId** (number) - User ID
- **title** (string) - Post title
- **body** (string) - Post body

#### Response Example
[
  {
    "id": 1,
    "userId": 1,
    "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
  }
]
```

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

### GET all posts with Fetch API

Source: https://jsonplaceholder.typicode.com/#guide

Fetches a list of all posts. Returns an array of post objects.

```javascript
fetch('https://jsonplaceholder.typicode.com/posts')
  .then(response => response.json())
  .then(json => console.log(json))
```

```json
[
  { "userId": 1, "id": 1, "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", "body": "quia et suscipit…" },
  { "userId": 1, "id": 2, "title": "qui est esse", "body": "est rerum tempore vitae…" },
  // … 100 posts
]
```

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

### GET /posts/1

Source: https://jsonplaceholder.typicode.com/#guide

Retrieves a single post by its ID. The ID is specified in the path.

```APIDOC
## GET /posts/1

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

### Method
GET

### Endpoint
/posts/{id}

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

### Response
#### Success Response (200)
- **id** (number) - Post ID
- **userId** (number) - User ID
- **title** (string) - Post title
- **body** (string) - Post body

#### Response Example
{
  "id": 1,
  "userId": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}
```

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

### GET /posts/1

Source: https://jsonplaceholder.typicode.com/#guide

Fetches a single post resource by its ID. Returns the post object with userId, id, title, and body fields.

```APIDOC
## GET /posts/1

### Description
Fetches a single post resource by its ID.

### Method
GET

### Endpoint
https://jsonplaceholder.typicode.com/posts/1

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the post to retrieve.

### Request Example
```
fetch('https://jsonplaceholder.typicode.com/posts/1')
  .then(response => response.json())
  .then(json => console.log(json))
```

### Response
#### Success Response (200)
- **userId** (integer) - The ID of the user who created the post.
- **id** (integer) - The post ID.
- **title** (string) - The title of the post.
- **body** (string) - The body content of the post.

#### Response Example
```
{
  "userId": 1,
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}
```
```

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

### GET /posts/1/comments

Source: https://jsonplaceholder.typicode.com/#guide

Fetches comments for a specific post using a nested route. Equivalent to /comments?postId=1.

```APIDOC
## GET /posts/1/comments

### Description
Fetches comments for a specific post using a nested route. Equivalent to /comments?postId=1.

### Method
GET

### Endpoint
https://jsonplaceholder.typicode.com/posts/1/comments

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the post whose comments to retrieve.

### Request Example
```
fetch('https://jsonplaceholder.typicode.com/posts/1/comments')
  .then(response => response.json())
  .then(json => console.log(json))
```

### Response
#### Success Response (200)
- **array of comments** - Each comment object contains postId, id, name, email, and body fields.

#### Response Example
```
[
  { "postId": 1, "id": 1, "name": "id labore ex et quam laborum", "email": "Eliseo@gardner.biz", "body": "laudantium enim quasi…" },
  { "postId": 1, "id": 2, "name": "quo vero reiciendis velit similique earum", "email": "Jayne_Kuhic@sydney.com", "body": "est natus enim nihil…" },
  // … 5 comments
]
```
```

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

### GET a single post with Fetch API

Source: https://jsonplaceholder.typicode.com/#guide

Fetches a single post by ID. Returns the post object with userId, id, title, and body.

```javascript
fetch('https://jsonplaceholder.typicode.com/posts/1')
  .then(response => response.json())
  .then(json => console.log(json))
```

```json
{
  "userId": 1,
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}
```

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

### GET /posts/1/comments

Source: https://jsonplaceholder.typicode.com/#guide

Retrieves all comments for a specific post. The post ID is specified in the path.

```APIDOC
## GET /posts/1/comments

### Description
Retrieves all comments for a specific post.

### Method
GET

### Endpoint
/posts/{id}/comments

### Parameters
#### Path Parameters
- **id** (number) - Required - The ID of the post whose comments to retrieve.

### Response
#### Success Response (200)
- **postId** (number) - Post ID
- **id** (number) - Comment ID
- **name** (string) - Commenter name
- **email** (string) - Commenter email
- **body** (string) - Comment body

#### Response Example
[
  {
    "postId": 1,
    "id": 1,
    "name": "id labore ex et quam laborum",
    "email": "Eliseo@gardner.biz",
    "body": "laudantium enim quasi est quidem magnam voluptate ipsam eos\ntempora quo necessitatibus\ndolor quam autem quasi\nreiciendis et nam sapiente accusantium"
  }
]
```

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

### GET /posts?userId=1

Source: https://jsonplaceholder.typicode.com/#guide

Fetches all posts that belong to a specific user using a query parameter for filtering.

```APIDOC
## GET /posts?userId=1

### Description
Fetches all posts that belong to a specific user using a query parameter for filtering.

### Method
GET

### Endpoint
https://jsonplaceholder.typicode.com/posts?userId=1

### Parameters
#### Query Parameters
- **userId** (integer) - Required - The user ID to filter posts by.

### Request Example
```
fetch('https://jsonplaceholder.typicode.com/posts?userId=1')
  .then(response => response.json())
  .then(json => console.log(json))
```

### Response
#### Success Response (200)
- **array of posts** - Each post object contains userId, id, title, and body fields.

#### Response Example
```
[
  { "userId": 1, "id": 1, "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", "body": "quia et suscipit…" },
  { "userId": 1, "id": 2, "title": "qui est esse", "body": "est rerum tempore vitae…" },
  // … 10 posts
]
```
```

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

### GET /posts/{id}

Source: https://jsonplaceholder.typicode.com/

Retrieves a single post by its unique ID. This endpoint is part of the JSONPlaceholder fake REST API and returns the post object with the specified ID.

```APIDOC
## GET /posts/1

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

### Method
GET

### Endpoint
https://jsonplaceholder.typicode.com/posts/1

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

### Response
#### Success Response (200)
- **userId** (number) - The ID of the user who authored the post.
- **id** (number) - The post ID.
- **title** (string) - The title of the post.
- **body** (string) - The body content of the post.

#### Response Example
```
{
  "userId": 1,
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}
```
```

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

### GET /posts?userId={userId}

Source: https://jsonplaceholder.typicode.com/

Filters posts by user ID. This endpoint demonstrates basic filtering functionality using query parameters.

```APIDOC
## GET /posts?userId=1

### Description
Retrieves all posts that belong to a specific user. Filtering is supported through query parameters.

### Method
GET

### Endpoint
https://jsonplaceholder.typicode.com/posts?userId=1

### Parameters
#### Query Parameters
- **userId** (number) - Required - The ID of the user whose posts to retrieve.

### Response
#### Success Response (200)
- **List of Post objects**: Each post object contains fields such as `userId`, `id`, `title`, and `body`.

#### Response Example
```
[
  { "userId": 1, "id": 1, "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", "body": "quia et suscipit…" },
  { "userId": 1, "id": 2, "title": "qui est esse", "body": "est rerum tempore vitae…" },
  // … 10 posts
]
```
```

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

### GET /comments?postId=1

Source: https://jsonplaceholder.typicode.com/#guide

Retrieves comments filtered by the postId query parameter. This allows fetching comments for a specific post without using a nested route.

```APIDOC
## GET /comments?postId=1

### Description
Retrieves comments filtered by the postId query parameter.

### Method
GET

### Endpoint
/comments

### Parameters
#### Query Parameters
- **postId** (number) - Required - The ID of the post to filter comments by.

### Response
#### Success Response (200)
- **postId** (number) - Post ID
- **id** (number) - Comment ID
- **name** (string) - Commenter name
- **email** (string) - Commenter email
- **body** (string) - Comment body

#### Response Example
[
  {
    "postId": 1,
    "id": 1,
    "name": "id labore ex et quam laborum",
    "email": "Eliseo@gardner.biz",
    "body": "laudantium enim quasi est quidem magnam voluptate ipsam eos\ntempora quo necessitatibus\ndolor quam autem quasi\nreiciendis et nam sapiente accusantium"
  }
]
```

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

### GET nested comments for a post with Fetch API

Source: https://jsonplaceholder.typicode.com/#guide

Fetches comments for a specific post using a nested route. Equivalent to /comments?postId=1. One level of nested route is available.

```javascript
// Equivalent to /comments?postId=1
fetch('https://jsonplaceholder.typicode.com/posts/1/comments')
  .then(response => response.json())
  .then(json => console.log(json))
```

```json
[
  { "postId": 1, "id": 1, "name": "id labore ex et quam laborum", "email": "Eliseo@gardner.biz", "body": "laudantium enim quasi…" },
  { "postId": 1, "id": 2, "name": "quo vero reiciendis velit similique earum", "email": "Jayne_Kuhic@sydney.com", "body": "est natus enim nihil…" },
  // … 5 comments
]
```

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

### POST create a post with Fetch API

Source: https://jsonplaceholder.typicode.com/#guide

Creates a new post. The server does not actually create the resource; the response is faked as if it did.

```javascript
fetch('https://jsonplaceholder.typicode.com/posts', {
  method: 'POST',
  body: JSON.stringify({
    title: 'foo',
    body: 'bar',
    userId: 1,
  }),
  headers: {
    'Content-type': 'application/json; charset=UTF-8',
  },
})
  .then(response => response.json())
  .then(json => console.log(json))
```

```json
{
  "title": "foo",
  "body": "bar",
  "userId": 1,
  "id": 101
}
```

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

### POST /posts

Source: https://jsonplaceholder.typicode.com/#guide

Creates a new post resource. The server returns a fake response with a new ID, but the resource is not actually stored.

```APIDOC
## POST /posts

### Description
Creates a new post resource. The server returns a fake response with a new ID, but the resource is not actually stored.

### Method
POST

### Endpoint
https://jsonplaceholder.typicode.com/posts

### Parameters
#### Request Body
- **title** (string) - Required - The title of the post.
- **body** (string) - Required - The body content of the post.
- **userId** (integer) - Required - The ID of the user who created the post.

### Request Example
```
fetch('https://jsonplaceholder.typicode.com/posts', {
  method: 'POST',
  body: JSON.stringify({
    title: 'foo',
    body: 'bar',
    userId: 1,
  }),
  headers: {
    'Content-type': 'application/json; charset=UTF-8',
  },
})
  .then(response => response.json())
  .then(json => console.log(json))
```

### Response
#### Success Response (200)
- **title** (string) - The title of the post.
- **body** (string) - The body content of the post.
- **userId** (integer) - The ID of the user who created the post.
- **id** (integer) - The new post ID (faked).

#### Response Example
```
{
  "title": "foo",
  "body": "bar",
  "userId": 1,
  "id": 101
}
```
```

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

### POST /posts

Source: https://jsonplaceholder.typicode.com/#guide

Creates a new post. The request body should contain the post data.

```APIDOC
## POST /posts

### Description
Creates a new post.

### Method
POST

### Endpoint
/posts

### Parameters
#### Request Body
- **title** (string) - Required - The title of the post.
- **body** (string) - Required - The body of the post.
- **userId** (number) - Required - The ID of the user who created the post.

### Request Example
{
  "title": "foo",
  "body": "bar",
  "userId": 1
}

### Response
#### Success Response (201)
- **id** (number) - The ID of the created post.
- **title** (string) - The title of the post.
- **body** (string) - The body of the post.
- **userId** (number) - The ID of the user.

#### Response Example
{
  "id": 101,
  "title": "foo",
  "body": "bar",
  "userId": 1
}
```

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

### PUT /posts/1

Source: https://jsonplaceholder.typicode.com/#guide

Updates an existing post resource. The server returns a fake response with the updated fields, but the resource is not actually updated.

```APIDOC
## PUT /posts/1

### Description
Updates an existing post resource. The server returns a fake response with the updated fields, but the resource is not actually updated.

### Method
PUT

### Endpoint
https://jsonplaceholder.typicode.com/posts/1

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

#### Request Body
- **id** (integer) - Required - The ID of the post.
- **title** (string) - Required - The new title of the post.
- **body** (string) - Required - The new body content of the post.
- **userId** (integer) - Required - The ID of the user who created the post.

### Request Example
```
fetch('https://jsonplaceholder.typicode.com/posts/1', {
  method: 'PUT',
  body: JSON.stringify({
    id: 1,
    title: 'foo',
    body: 'bar',
    userId: 1,
  }),
  headers: {
    'Content-type': 'application/json; charset=UTF-8',
  },
})
  .then(response => response.json())
  .then(json => console.log(json))
```

### Response
#### Success Response (200)
- **id** (integer) - The post ID.
- **title** (string) - The updated title.
- **body** (string) - The updated body.
- **userId** (integer) - The user ID.

#### Response Example
```
{
  "id": 1,
  "title": "foo",
  "body": "bar",
  "userId": 1
}
```
```

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

### PATCH /posts/1

Source: https://jsonplaceholder.typicode.com/#guide

Partially updates an existing post resource. The server returns a fake response with the patched fields, but the resource is not actually patched.

```APIDOC
## PATCH /posts/1

### Description
Partially updates an existing post resource. The server returns a fake response with the patched fields, but the resource is not actually patched.

### Method
PATCH

### Endpoint
https://jsonplaceholder.typicode.com/posts/1

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the post to patch.

#### Request Body
- **title** (string) - Required - The new title of the post.

### Request Example
```
fetch('https://jsonplaceholder.typicode.com/posts/1', {
  method: 'PATCH',
  body: JSON.stringify({
    title: 'foo',
  }),
  headers: {
    'Content-type': 'application/json; charset=UTF-8',
  },
})
  .then(response => response.json())
  .then(json => console.log(json))
```

### Response
#### Success Response (200)
- **userId** (integer) - The user ID.
- **id** (integer) - The post ID.
- **title** (string) - The updated title.
- **body** (string) - The body content (unchanged).

#### Response Example
```
{
  "userId": 1,
  "id": 1,
  "title": "foo",
  "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}
```
```

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

### DELETE /posts/{id}

Source: https://jsonplaceholder.typicode.com/

Deletes a post by its ID. The server simulates the deletion and returns an empty object as a response.

```APIDOC
## DELETE /posts/1

### Description
Deletes a post with the specified ID. The resource is not really deleted on the server, but the response is faked as if it were.

### Method
DELETE

### Endpoint
https://jsonplaceholder.typicode.com/posts/1

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

### Response
#### Success Response (200)
- **empty object** - Returns an empty object indicating deletion.

#### Response Example
```
{}
```
```

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

### DELETE /posts/1

Source: https://jsonplaceholder.typicode.com/#guide

Deletes a post resource. The server returns an empty object, but the resource is not actually deleted.

```APIDOC
## DELETE /posts/1

### Description
Deletes a post resource. The server returns an empty object, but the resource is not actually deleted.

### Method
DELETE

### Endpoint
https://jsonplaceholder.typicode.com/posts/1

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the post to delete.

### Request Example
```
fetch('https://jsonplaceholder.typicode.com/posts/1', {
  method: 'DELETE',
})
  .then(response => response.json())
  .then(json => console.log(json))
```

### Response
#### Success Response (200)
- **empty object** - The response is an empty object.

#### Response Example
```
{}
```
```

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

### PUT /posts/1

Source: https://jsonplaceholder.typicode.com/#guide

Updates an existing post. The ID is specified in the path, and the request body contains the updated data.

```APIDOC
## PUT /posts/1

### Description
Updates an existing post.

### Method
PUT

### Endpoint
/posts/{id}

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

#### Request Body
- **id** (number) - Required - The ID of the post.
- **title** (string) - Required - The updated title.
- **body** (string) - Required - The updated body.
- **userId** (number) - Required - The ID of the user.

### Request Example
{
  "id": 1,
  "title": "foo",
  "body": "bar",
  "userId": 1
}

### Response
#### Success Response (200)
- **id** (number) - The ID of the updated post.
- **title** (string) - The updated title.
- **body** (string) - The updated body.
- **userId** (number) - The ID of the user.

#### Response Example
{
  "id": 1,
  "title": "foo",
  "body": "bar",
  "userId": 1
}
```

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

### PUT update a post with Fetch API

Source: https://jsonplaceholder.typicode.com/#guide

Updates a post by ID. The server does not actually update the resource; the response is faked as if it did.

```javascript
fetch('https://jsonplaceholder.typicode.com/posts/1', {
  method: 'PUT',
  body: JSON.stringify({
    id: 1,
    title: 'foo',
    body: 'bar',
    userId: 1,
  }),
  headers: {
    'Content-type': 'application/json; charset=UTF-8',
  },
})
  .then(response => response.json())
  .then(json => console.log(json))
```

```json
{
  "id": 1,
  "title": "foo",
  "body": "bar",
  "userId": 1
}
```

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

### PATCH partially update a post with Fetch API

Source: https://jsonplaceholder.typicode.com/#guide

Partially updates a post by ID. The server does not actually patch the resource; the response is faked as if it did.

```javascript
fetch('https://jsonplaceholder.typicode.com/posts/1', {
  method: 'PATCH',
  body: JSON.stringify({
    title: 'foo',
  }),
  headers: {
    'Content-type': 'application/json; charset=UTF-8',
  },
})
  .then(response => response.json())
  .then(json => console.log(json))
```

```json
{
  "userId": 1,
  "id": 1,
  "title": "foo",
  "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}
```

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

### Filter posts by userId with Fetch API

Source: https://jsonplaceholder.typicode.com/#guide

Fetches all posts belonging to a specific user using the userId query parameter. Basic filtering is supported through query parameters.

```javascript
// All the posts that belong to the first user
fetch('https://jsonplaceholder.typicode.com/posts?userId=1')
  .then(response => response.json())
  .then(json => console.log(json))
```

```json
[
  { "userId": 1, "id": 1, "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit", "body": "quia et suscipit…" },
  { "userId": 1, "id": 2, "title": "qui est esse", "body": "est rerum tempore vitae…" },
  // … 10 posts
]
```

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

### PATCH /posts/1

Source: https://jsonplaceholder.typicode.com/#guide

Partially updates an existing post. The ID is specified in the path, and the request body contains only the fields to update.

```APIDOC
## PATCH /posts/1

### Description
Partially updates an existing post.

### Method
PATCH

### Endpoint
/posts/{id}

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

#### Request Body
- **title** (string) - Optional - The updated title.
- **body** (string) - Optional - The updated body.
- **userId** (number) - Optional - The ID of the user.

### Request Example
{
  "title": "foo"
}

### Response
#### Success Response (200)
- **id** (number) - The ID of the updated post.
- **title** (string) - The updated title.
- **body** (string) - The updated body.
- **userId** (number) - The ID of the user.

#### Response Example
{
  "id": 1,
  "title": "foo",
  "body": "bar",
  "userId": 1
}
```

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

### DELETE a post with Fetch API

Source: https://jsonplaceholder.typicode.com/#guide

Deletes a post by ID. The server does not actually delete the resource; the response is faked as an empty object.

```javascript
fetch('https://jsonplaceholder.typicode.com/posts/1', {
  method: 'DELETE',
})
  .then(response => response.json())
  .then(json => console.log(json))
```

```json
{}
```

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

### DELETE /posts/1

Source: https://jsonplaceholder.typicode.com/#guide

Deletes a post by its ID. The ID is specified in the path.

```APIDOC
## DELETE /posts/1

### Description
Deletes a post by its ID.

### Method
DELETE

### Endpoint
/posts/{id}

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

### Response
#### Success Response (200)
- **id** (number) - The ID of the deleted post.

#### Response Example
{}
```
Tokens:
Raw