Developer Overview

Api Response

3min

Standard Api Response
The Nuflow Api responses are standardised to follow a convention.
code refers to Status Code﻿﻿
status refers to a string which is meaningful for readers
data is the response json which varies depending upon the api.
message is a field only available when code refers to an Error with details packed in the error_details field. 
Sample Success Response

JSON
{
    "code": 200,
    "status": "OK",
    "data": {
        "key1": "value",
        "key2": "more"
    }
}
{
    "code": 200,
    "status": "OK",
    "data": {
        "key1": "value",
        "key2": "more"
    }
}
﻿

Sample Error Response 
        
JSON
{
    "code": 404,
    "status": "NOT_FOUND",
    "message": "Not Found",
     error_details": {
        "password": [
          "This field is required."
        ]
    }
}
{
    "code": 404,
    "status": "NOT_FOUND",
    "message": "Not Found",
     error_details": {
        "password": [
          "This field is required."
        ]
    }
}
﻿
﻿

Updated 27 Sep 2023

Did this page help you?

Status Code

Metadata

Docs powered by Archbee

TABLE OF CONTENTS

Standard Api Response

Sample Success Response

Sample Error Response