API reference
Account & conventions
Who a token belongs to, and the rules every endpoint shares.
Paths below are relative to
https://recipejam.com/api/v1
/user
Who am I
The person the token belongs to. The quickest way to check a token works at all.
Response
200
| Field | Type | Notes |
|---|---|---|
id
|
string | Opaque identifier. |
name
|
string | Their name. |
email
|
string | Their email address. |
Try these
The endpoints on this page, sent from your browser with your own token. Nothing is proxied through us.
Kept in this browser only, so it survives a reload. It is never sent to RecipeJam except as the header on the request you ask for.
The same request, as curl
The pagination envelope
Every listing arrives in this. Page through by following `links.next` until it is null, rather than counting pages yourself.
| Field | Type | Notes |
|---|---|---|
data
|
array | The page of results. |
links.first
|
string | URL of the first page. |
links.last
|
string | URL of the last page. |
links.prev
|
string, or null | Null on the first page. |
links.next
|
string, or null | Null on the last page. The presence of this is the only reliable way to know there is more. |
meta.current_page
|
integer | Which page this is, from 1. |
meta.last_page
|
integer | How many pages there are. |
meta.per_page
|
integer | How many were asked for. |
meta.total
|
integer | How many there are altogether. |
meta.from
|
integer, or null | Index of the first row on this page. Null on an empty page. |
meta.to
|
integer, or null | Index of the last row on this page. |