Laravel - Return json along with http status code

Question

If I return an object:

return Response::json([
    'hello' => $value
]);

the status code will be 200. How can I change it to 201, with a message and send it with the json object?.

I don't know if there is a way to just set the status code in Laravel.

score 147 · Accepted Answer · edited May 23 '17 at 12:34

147

You can use http_response_code() to set HTTP response code.

If you pass no parameters then http_response_code will get the current status code. If you pass a parameter it will set the response code.

http_response_code(201); // Set response status code to 201

For Laravel(Reference from: https://stackoverflow.com/a/14717895/2025923):

return Response::json([
    'hello' => $value
], 201); // Status code here

edited May 23 '17 at 12:34

Community

1
1

answered Jun 30 '15 at 06:34

Tushar

85,780
21
159
179

3

Keep in mind that **Symfony\Component\HttpFoundation\Response** has its own predefined constants for http status codes, and if you use other than that it will change your status into something close to it... i.e. if you want to set status **449**, you will always get status **500** – Mladen Janjetovic Nov 05 '15 at 23:11
2

@Tushar what if I don't want to send any data back, just a 200 response? Is `response()->json([], 200);` fit for purpose in this situation? Or is 200 implicit? – Jonathan Jul 05 '16 at 10:43
+ (201) this answer safes my evening :) – Maytham Fahmi Oct 23 '16 at 00:29
1

`use Illuminate\Http\Response;` and `return new Response(['message' => 'test'], 422);` worked for me – Derk Jan Speelman Oct 13 '20 at 11:48

score 89 · Answer 2 · edited Feb 20 '19 at 04:10

89

This is how I do it in Laravel 5

return Response::json(['hello' => $value],201);

Or using a helper function:

return response()->json(['hello' => $value], 201);

edited Feb 20 '19 at 04:10

Yevgeniy Afanasyev

37,872
26
173
191

answered Jun 30 '15 at 06:38

Jeremy C.

2,405
1
12
28

1

@timeNomad What are the pros and cons of these two methods - which is recommended? – DJC Apr 28 '16 at 11:46
2

@DJC on first method you will be able to use Response:: several times loading only once. On second method you will call that class to each time you use response()-> (no problem if you'll use only one). – Marcelo Agimóvel Apr 07 '18 at 20:56

score 48 · Answer 3 · edited Feb 20 '19 at 04:12

48

I think it is better practice to keep your response under single control and for this reason I found out the most official solution.

response()->json([...])
    ->setStatusCode(Response::HTTP_OK, Response::$statusTexts[Response::HTTP_OK]);

add this after namespace declaration:

use Illuminate\Http\Response;

edited Feb 20 '19 at 04:12

Yevgeniy Afanasyev

37,872
26
173
191

answered Oct 31 '16 at 13:42

TKoutsou

481
4
2

Thanks, I was looking for a reference to this. Do you happen to have a link to the other available response names such as 201, 400 etc and not just the 200 (HTTP_OK)? I've tried googling it but haven't been able to find it quite yet! – jjmu15 May 19 '20 at 08:45
1

Nevermind... found it. Here is a complete list for anyone else who may be looking for it: https://gist.github.com/jeffochoa/a162fc4381d69a2d862dafa61cda0798 – jjmu15 May 19 '20 at 08:50

score 15 · Answer 4 · edited Sep 29 '17 at 14:34

15

There are multiple ways

return \Response::json(['hello' => $value], STATUS_CODE);

return response()->json(['hello' => $value], STATUS_CODE);

where STATUS_CODE is your HTTP status code you want to send. Both are identical.

if you are using Eloquent model, then simple return will also be auto converted in JSON by default like,

return User::all();

edited Sep 29 '17 at 14:34

Nico Burns

16,639
10
40
54

answered Sep 20 '16 at 11:00

iSensical

747
5
8

score 6 · Answer 5 · answered Sep 15 '20 at 19:12

6

laravel 7.* You don't have to speicify JSON RESPONSE cause it's automatically converted it to JSON

return response(['Message'=>'Wrong Credintals'], 400);

answered Sep 15 '20 at 19:12

Mohammed AL MahmoOd

91
1
8

score 3 · Answer 6 · answered May 08 '18 at 15:08

3

return response(['title' => trans('web.errors.duplicate_title')], 422); //Unprocessable Entity

Hope my answer was helpful.

answered May 08 '18 at 15:08

Mikayel Margaryan

764
1
7
16

this one is helpful ! Thanks :) – Faiyaj Oct 14 '21 at 17:47

Deena Nath Soni · Answer 7 · 2022-10-27T04:57:30.797

2

I always use this type of json response format, this will help you...

return response()->json(['success'=>'true','message' => 'Successfully Done.'], 200);

edited Oct 27 '22 at 04:57

answered Oct 27 '22 at 04:50

Deena Nath Soni

21
3

score 1 · Answer 8 · answered Jan 08 '20 at 13:18

It's better to do it with helper functions rather than Facades. This solution will work well from Laravel 5.7 onwards

//import dependency
use Illuminate\Http\Response;

//snippet
return \response()->json([
   'status' => '403',//sample entry
   'message' => 'ACCOUNT ACTION HAS BEEN DISABLED',//sample message
], Response::HTTP_FORBIDDEN);//Illuminate\Http\Response sets appropriate headers

score 0 · Answer 9 · answered Feb 16 '19 at 05:27

0

I prefer the response helper myself:

    return response()->json(['message' => 'Yup. This request succeeded.'], 200);

answered Feb 16 '19 at 05:27

Dylan Pierce

4,313
3
35
45

Emre Dikmen · Answer 10 · 2023-02-24T23:51:39.043

-1

use Symfony\Component\HttpFoundation\Response;

  return response()->json([
            'message' => 'success',
            'status' => Response::HTTP_OK
        ]);

edited Feb 24 '23 at 23:51

answered Feb 24 '23 at 23:50

Emre Dikmen

1
1

1

While this code snippet may be the solution, including a detailed explanation really helps to improve the quality of your post. Remember that you are answering the question for readers in the future, and those people might not know the reasons for your code suggestion. – Shawn Hemelstrand Feb 26 '23 at 01:36

Laravel - Return json along with http status code

10 Answers10

Linked