Read (GET)

Use the GET method to fetch data from your endpoint.

Use one or more uniqueId’s to fetch specific records from the database. If not specified all records will be returned.

Request data

HTTP method: GET

URL format: https://baseUrl/versionNumber/customEndpointRoute/userEndpoint?key=apiKey[&uniqueId=uniqueId][&dataOnly=true]

Example:

https://app.rested.dev/api/1/ce/examples/unsecure-endpoint?key=d59eb2859c284168ac48aef65046d5dd[&uniqueId=45e964d5b6ed49b1a2e14d8ac724109e][&dataOnly=true]

Request Parameters

The following table describes the Request parameters.

Parameter	Description	Required
baseUrl	Base url for calling the API. Value: app.rested.dev/api	Yes
versionNumber	Service version. Value: The current value is 1.	Yes
customEndpointRoute	The route which identifies custom endpoints. Default value: ce	Yes
userEndpoint	The endpoint name generated by the user. Value: the name created at https://app.rested.dev	Yes
apiKey	The API Key of the project.	Yes
uniqueId	If used, the endpoint will only serve the record with a matching uniqueId. It is also possible to provide multiple uniqueId's. If none is passed, the endpoint will serve all the records.	No
dataOnly	If used, the endpoint will only serve the user data. It won’t include fields such as uniqueId, createdAt, updateAt. Value: true	No
masterKey	Overrides the need for Access tokens or restrictions applied to Authentication endpoints. Don't use this key in your client application. For more information please refer to projects. Value: the masterKey created at https://app.rested.dev.	No
jsonata	Use this parameter to query, filter, sort and transform your data (and more!) It accepts JSONata compatible expressions. The evaluation of the expression is applied to the output of the endpoint, including when other parameters are used (e.g. dataOnly). Check the JSONata documentation on their page, or check our quick guide, JSONata, query and transform.	No

Example:

https://app.rested.dev/api/1/ce/examples/unsecure-endpoint?key=d59eb2859c284168ac48aef65046d5dd&uniqueId=45e964d5b6ed49b1a2e14d8ac724109e

// With multiple uniqueIds:

https://app.rested.dev/api/1/ce/examples/unsecure-endpoint?key=d59eb2859c284168ac48aef65046d5dd&uniqueId=45e964d5b6ed49b1a2e14d8ac724109e&uniqueId=3f38bf9e1bb54d2396d1f1b8fbba1630

Request Cookies

Header	Description	Required
__Secure-rested-access-token	The Access token is required for secure endpoints. It is obtained when doing a login and it is stored in an httpOnly cookie. To automatically include it in the request you need to set the following property: // using fetch { credentials: 'include' } // using axios { withCredentials: true } Alternatively you can also use the Authorization header. For more information please refer to  the login documentation and Secure Endpoints documentation.	Yes - if endpoint is secure and Authorization header is not used

Request Headers

Header	Description	Required
Authorization	The Access token is required for secure endpoints. You should use this header if you are not using the httpOnly cookie to access a Secure endpoint. For more information please refer to  the login documentation and Secure Endpoints documentation.	Yes - if endpoint is secure and httpOnly cookie is not used

Response data

Error codes

Error code	Description
400	Possible reasons: Endpoint or API Key not valid.
401	If the endpoint is secure and the access token is missing or is not valid. It may also return this error if the user no longer exists.
403	Missing API Key, not allowed origin or disallowed request without orign.

Successful response

{
    uniqueId: "3f38bf9e1bb54d2396d1f1b8fbba1630",
    data: { property: "data" },
    createdAt: "2020-12-27T10:58:45.000Z",
    updatedAt: "2020-12-27T10:58:45.000Z"
}

Example of a successful response using dataOnly=true:

{
"propertyFive": "555"
}

If the response includes multiple records it returns an Array[] of records:

[{
    uniqueId: "3f38bf9e1bb54d2396d1f1b8fbba1630",
    data: { property: "data" },
    createdAt: "2020-12-27T10:58:45.000Z",
    updatedAt: "2020-12-27T10:58:45.000Z"
}, {
    uniqueId: "3f38bf9e1bb54d2396d1f1b8fbba1630",
    data: { property: "data2" },
    createdAt: "2020-12-27T10:58:45.000Z",
    updatedAt: "2020-12-27T10:58:45.000Z"
}]