Mock API

The live reference demo for vitepress-openapi-docs, backed by a mock server at api.rodin.dev/mock. OpenAPI 3.1, 107 operations across 15 tags, 34 webhooks, bearer auth, callbacks, oneOf, rich examples: everything the plugin renders, rendered here.

Pick any operation from the sidebar and hit Try-It — the request goes to the real origin, CORS is open, you get real JSON back. The spec is fetched at build time so this page mirrors the live contract.

albums

GET/albums

List all albums

Paginated list of albums. Supports filtering, range operators (`_gte`, `_lte`, `_gt`, `_lt`, `_ne`, `_like`), full-text search, sorting, field selection, and relation expansion.

Parameters 12

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsAlbum

Response examples

200Paginated array of albums

application/json example derived from schema

[
  {
    "id": 1,
    "userId": 1,
    "title": "Abstract",
    "description": "Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
    "coverImage": "https://picsum.photos/seed/album1/600/400",
    "photoCount": 39,
    "isPublic": true,
    "createdAt": "2024-07-02T09:01:49.954Z"
  }
]

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/albums'

fetch("https://api.rodin.dev/mock/albums", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/albums"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/albums

Create album

Create a new album. Fields `id`, `createdAt`, `updatedAt` are auto-generated. Triggers `albums.created` webhook.

ReturnsAlbum

AcceptsAlbumInput

Response examples

201Album created

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Abstract",
  "description": "Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "coverImage": "https://picsum.photos/seed/album1/600/400",
  "photoCount": 39,
  "isPublic": true,
  "createdAt": "2024-07-02T09:01:49.954Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

413413 — body exceeds 64 KB

application/json

{
  "error": {
    "status": 413,
    "message": "Request body too large",
    "details": {
      "maxSize": "64 KB"
    }
  }
}

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "title": "Summer 2026"
}' 'https://api.rodin.dev/mock/albums'

fetch("https://api.rodin.dev/mock/albums", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"title\": \"Summer 2026\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/albums"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"title\": \"Summer 2026\"\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "title": "Summer 2026" }

GET/albums/{id}

Get album by ID

Retrieve a single album. Supports ETag conditional requests via `If-None-Match`.

Parameters 4

Name	Type	Description
_fields	query · string	Sparse fieldset — comma-separated fields to return. Leave blank for the full object.
_expand	query · string	Expand parent relations inline. Applies only when the resource has a matching parent (e.g. `user` on posts).
_embed	query · string	Embed child collections. Applies only when the resource has a matching child (e.g. `comments` on posts).

ReturnsAlbum

Response examples

200The album

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Abstract",
  "description": "Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "coverImage": "https://picsum.photos/seed/album1/600/400",
  "photoCount": 39,
  "isPublic": true,
  "createdAt": "2024-07-02T09:01:49.954Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/albums/{id}'

fetch("https://api.rodin.dev/mock/albums/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/albums/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PUT/albums/{id}

Replace album

Full replacement. All mutable fields overwritten. Triggers `albums.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsAlbum

AcceptsAlbumInput

Response examples

200Album replaced

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Abstract",
  "description": "Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "coverImage": "https://picsum.photos/seed/album1/600/400",
  "photoCount": 39,
  "isPublic": true,
  "createdAt": "2024-07-02T09:01:49.954Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PUT -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "title": "Summer 2026"
}' 'https://api.rodin.dev/mock/albums/{id}'

fetch("https://api.rodin.dev/mock/albums/{id}", {
  method: "PUT",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"title\": \"Summer 2026\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/albums/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"title\": \"Summer 2026\"\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "title": "Summer 2026" }

PATCH/albums/{id}

Partially update album

Partial update — only provided fields change. Triggers `albums.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsAlbum

AcceptsAlbumInput

Response examples

200Album updated

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Abstract",
  "description": "Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "coverImage": "https://picsum.photos/seed/album1/600/400",
  "photoCount": 39,
  "isPublic": true,
  "createdAt": "2024-07-02T09:01:49.954Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "title": "Summer 2026"
}' 'https://api.rodin.dev/mock/albums/{id}'

fetch("https://api.rodin.dev/mock/albums/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"title\": \"Summer 2026\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/albums/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"title\": \"Summer 2026\"\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "title": "Summer 2026" }

DELETE/albums/{id}

Delete album

Permanently remove a album. Returns deleted resource. Triggers `albums.deleted` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsAlbum

Response examples

200Deleted album

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Abstract",
  "description": "Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "coverImage": "https://picsum.photos/seed/album1/600/400",
  "photoCount": 39,
  "isPublic": true,
  "createdAt": "2024-07-02T09:01:49.954Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/albums/{id}'

fetch("https://api.rodin.dev/mock/albums/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/albums/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/albums/{id}/photos

List album's photos

Retrieve album's photos. Same filtering, sorting, and pagination as `/photos`.

Parameters 13

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsPhoto

Response examples

200Array of photos

application/json example derived from schema

[
  {
    "id": 1,
    "albumId": 1,
    "title": "Photo 1",
    "url": "https://picsum.photos/seed/1/800/960",
    "thumbnailUrl": "https://picsum.photos/seed/1/150/150",
    "width": 800,
    "height": 960,
    "size": 4803273,
    "format": "jpeg",
    "createdAt": "2026-07-24T20:47:13.121Z"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/albums/{id}/photos'

fetch("https://api.rodin.dev/mock/albums/{id}/photos", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/albums/{id}/photos"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

auth

GET/auth/basic-demo

HTTP Basic demo

Demonstrates HTTP Basic — intentionally present so API docs generators can render the Basic auth block. Any credentials accepted. Echoes the username back so you can confirm the header reached the server.

ReturnsBasicDemoResponse

Response examples

200Authenticated with Basic

application/json example derived from schema

{
  "authenticated": true,
  "scheme": "basic"
}

401401 — missing or expired Bearer token

application/json

{
  "error": {
    "status": 401,
    "message": "Authentication required"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/auth/basic-demo'

fetch("https://api.rodin.dev/mock/auth/basic-demo", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/auth/basic-demo"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/auth/login

Log in

Authenticate with email/password. **Mock: any password works for any seeded email.** The demo account `demo@example.com` is always present and carries admin role — use it for docs Try-It. Token valid 1 hour.

ReturnsAuthResponse

AcceptsAuthCredentials

Response examples

200Logged in

application/json example derived from schema

{
  "user": {
    "id": 1,
    "firstName": "Demo",
    "lastName": "User",
    "email": "demo@example.com",
    "username": "demo",
    "avatar": "https://i.pravatar.cc/150?u=demo",
    "phone": "+1-555-000-0001",
    "address": {
      "street": "1 Demo Way",
      "city": "Austin",
      "state": "TX",
      "zipCode": "78701",
      "country": "US",
      "geo": {
        "lat": 30.2672,
        "lng": -97.7431
      }
    },
    "company": {
      "name": "Demo Corp",
      "catchPhrase": "Seeded for docs and testing."
    },
    "website": "https://example.com/demo",
    "role": "admin",
    "age": 30,
    "bio": "Seeded demo account. Log in with any password.",
    "isActive": true,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2026-04-21T00:00:00.000Z"
  },
  "token": "string",
  "expiresAt": "2024-01-15T09:30:00Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

401401 — missing or expired Bearer token

application/json

{
  "error": {
    "status": 401,
    "message": "Authentication required"
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "email": "demo@example.com",
  "password": "any"
}' 'https://api.rodin.dev/mock/auth/login'

fetch("https://api.rodin.dev/mock/auth/login", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"email\": \"demo@example.com\",\n  \"password\": \"any\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/auth/login"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"email\": \"demo@example.com\",\n  \"password\": \"any\"\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "email": "demo@example.com", "password": "any" }

POST/auth/logout

Log out

Revoke the Bearer token.

Response examples

200Logged out

application/json example derived from schema

{
  "message": "Logged out"
}

Try It

Code examples

curl -X POST 'https://api.rodin.dev/mock/auth/logout'

fetch("https://api.rodin.dev/mock/auth/logout", {
  method: "POST",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/auth/logout"

response = requests.post(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/auth/me

Get current user

Returns profile for the provided Bearer token.

ReturnsUser

Response examples

200User profile

application/json example derived from schema

{
  "id": 1,
  "firstName": "Demo",
  "lastName": "User",
  "email": "demo@example.com",
  "username": "demo",
  "avatar": "https://i.pravatar.cc/150?u=demo",
  "phone": "+1-555-000-0001",
  "address": {
    "street": "1 Demo Way",
    "city": "Austin",
    "state": "TX",
    "zipCode": "78701",
    "country": "US",
    "geo": {
      "lat": 30.2672,
      "lng": -97.7431
    }
  },
  "company": {
    "name": "Demo Corp",
    "catchPhrase": "Seeded for docs and testing."
  },
  "website": "https://example.com/demo",
  "role": "admin",
  "age": 30,
  "bio": "Seeded demo account. Log in with any password.",
  "isActive": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2026-04-21T00:00:00.000Z"
}

401401 — missing or expired Bearer token

application/json

{
  "error": {
    "status": 401,
    "message": "Authentication required"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/auth/me'

fetch("https://api.rodin.dev/mock/auth/me", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/auth/me"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/auth/refresh

Refresh token

Exchange valid token for new one. Old token revoked.

ReturnsTokenResponse

Response examples

200New token

application/json example derived from schema

{
  "token": "string",
  "expiresAt": "2024-01-15T09:30:00Z"
}

401401 — missing or expired Bearer token

application/json

{
  "error": {
    "status": 401,
    "message": "Authentication required"
  }
}

Try It

Code examples

curl -X POST 'https://api.rodin.dev/mock/auth/refresh'

fetch("https://api.rodin.dev/mock/auth/refresh", {
  method: "POST",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/auth/refresh"

response = requests.post(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/auth/register

Register new user

Create account and receive token. Returns 409 if email exists.

ReturnsAuthResponse

AcceptsAuthCredentials

Response examples

201Registered

application/json example derived from schema

{
  "user": {
    "id": 1,
    "firstName": "Demo",
    "lastName": "User",
    "email": "demo@example.com",
    "username": "demo",
    "avatar": "https://i.pravatar.cc/150?u=demo",
    "phone": "+1-555-000-0001",
    "address": {
      "street": "1 Demo Way",
      "city": "Austin",
      "state": "TX",
      "zipCode": "78701",
      "country": "US",
      "geo": {
        "lat": 30.2672,
        "lng": -97.7431
      }
    },
    "company": {
      "name": "Demo Corp",
      "catchPhrase": "Seeded for docs and testing."
    },
    "website": "https://example.com/demo",
    "role": "admin",
    "age": 30,
    "bio": "Seeded demo account. Log in with any password.",
    "isActive": true,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2026-04-21T00:00:00.000Z"
  },
  "token": "string",
  "expiresAt": "2024-01-15T09:30:00Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

409409 — duplicate resource

application/json

{
  "error": {
    "status": 409,
    "message": "Email already registered"
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "email": "demo@example.com",
  "password": "any"
}' 'https://api.rodin.dev/mock/auth/register'

fetch("https://api.rodin.dev/mock/auth/register", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"email\": \"demo@example.com\",\n  \"password\": \"any\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/auth/register"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"email\": \"demo@example.com\",\n  \"password\": \"any\"\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "email": "demo@example.com", "password": "any" }

categories

GET/categories

List all categories

Paginated list of categories. Supports filtering, range operators (`_gte`, `_lte`, `_gt`, `_lt`, `_ne`, `_like`), full-text search, sorting, field selection, and relation expansion.

Parameters 12

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsCategory

Response examples

200Paginated array of categories

application/json example derived from schema

[
  {
    "id": 1,
    "name": "Electronics",
    "slug": "electronics",
    "description": "Gadgets, devices, and electronic accessories",
    "image": "https://picsum.photos/seed/cat1/300/200",
    "productCount": 5,
    "createdAt": "2022-01-06T04:19:58.076Z"
  }
]

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/categories'

fetch("https://api.rodin.dev/mock/categories", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/categories"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/categories

Create category

Create a new category. Fields `id`, `createdAt`, `updatedAt` are auto-generated. Triggers `categories.created` webhook.

ReturnsCategory

AcceptsCategoryInput

Response examples

201Category created

application/json example derived from schema

{
  "id": 1,
  "name": "Electronics",
  "slug": "electronics",
  "description": "Gadgets, devices, and electronic accessories",
  "image": "https://picsum.photos/seed/cat1/300/200",
  "productCount": 5,
  "createdAt": "2022-01-06T04:19:58.076Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

413413 — body exceeds 64 KB

application/json

{
  "error": {
    "status": 413,
    "message": "Request body too large",
    "details": {
      "maxSize": "64 KB"
    }
  }
}

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "name": "Electronics",
  "slug": "electronics"
}' 'https://api.rodin.dev/mock/categories'

fetch("https://api.rodin.dev/mock/categories", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"name\": \"Electronics\",\n  \"slug\": \"electronics\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/categories"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"name\": \"Electronics\",\n  \"slug\": \"electronics\"\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "name": "Electronics", "slug": "electronics" }

GET/categories/{id}

Get category by ID

Retrieve a single category. Supports ETag conditional requests via `If-None-Match`.

Parameters 4

Name	Type	Description
_fields	query · string	Sparse fieldset — comma-separated fields to return. Leave blank for the full object.
_expand	query · string	Expand parent relations inline. Applies only when the resource has a matching parent (e.g. `user` on posts).
_embed	query · string	Embed child collections. Applies only when the resource has a matching child (e.g. `comments` on posts).

ReturnsCategory

Response examples

200The category

application/json example derived from schema

{
  "id": 1,
  "name": "Electronics",
  "slug": "electronics",
  "description": "Gadgets, devices, and electronic accessories",
  "image": "https://picsum.photos/seed/cat1/300/200",
  "productCount": 5,
  "createdAt": "2022-01-06T04:19:58.076Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/categories/{id}'

fetch("https://api.rodin.dev/mock/categories/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/categories/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PUT/categories/{id}

Replace category

Full replacement. All mutable fields overwritten. Triggers `categories.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsCategory

AcceptsCategoryInput

Response examples

200Category replaced

application/json example derived from schema

{
  "id": 1,
  "name": "Electronics",
  "slug": "electronics",
  "description": "Gadgets, devices, and electronic accessories",
  "image": "https://picsum.photos/seed/cat1/300/200",
  "productCount": 5,
  "createdAt": "2022-01-06T04:19:58.076Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PUT -H 'Content-Type: application/json' -d '{
  "name": "Electronics",
  "slug": "electronics"
}' 'https://api.rodin.dev/mock/categories/{id}'

fetch("https://api.rodin.dev/mock/categories/{id}", {
  method: "PUT",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"name\": \"Electronics\",\n  \"slug\": \"electronics\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/categories/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"name\": \"Electronics\",\n  \"slug\": \"electronics\"\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "name": "Electronics", "slug": "electronics" }

PATCH/categories/{id}

Partially update category

Partial update — only provided fields change. Triggers `categories.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsCategory

AcceptsCategoryInput

Response examples

200Category updated

application/json example derived from schema

{
  "id": 1,
  "name": "Electronics",
  "slug": "electronics",
  "description": "Gadgets, devices, and electronic accessories",
  "image": "https://picsum.photos/seed/cat1/300/200",
  "productCount": 5,
  "createdAt": "2022-01-06T04:19:58.076Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "name": "Electronics",
  "slug": "electronics"
}' 'https://api.rodin.dev/mock/categories/{id}'

fetch("https://api.rodin.dev/mock/categories/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"name\": \"Electronics\",\n  \"slug\": \"electronics\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/categories/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"name\": \"Electronics\",\n  \"slug\": \"electronics\"\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "name": "Electronics", "slug": "electronics" }

DELETE/categories/{id}

Delete category

Permanently remove a category. Returns deleted resource. Triggers `categories.deleted` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsCategory

Response examples

200Deleted category

application/json example derived from schema

{
  "id": 1,
  "name": "Electronics",
  "slug": "electronics",
  "description": "Gadgets, devices, and electronic accessories",
  "image": "https://picsum.photos/seed/cat1/300/200",
  "productCount": 5,
  "createdAt": "2022-01-06T04:19:58.076Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/categories/{id}'

fetch("https://api.rodin.dev/mock/categories/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/categories/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/categories/{id}/products

List category's products

Retrieve category's products. Same filtering, sorting, and pagination as `/products`.

Parameters 13

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsProduct

Response examples

200Array of products

application/json example derived from schema

[
  {
    "id": 1,
    "categoryId": 4,
    "name": "Desk Lamp",
    "description": "Ultra-fast connectivity with rock-solid reliability.",
    "price": 161.28,
    "originalPrice": 231.38,
    "currency": "USD",
    "stock": 257,
    "sku": "SKU-00001",
    "rating": 4.4,
    "reviewCount": 188,
    "image": "https://picsum.photos/seed/prod1/400/400",
    "images": [
      "https://picsum.photos/seed/prod1-0/400/400",
      "https://picsum.photos/seed/prod1-1/400/400",
      "https://picsum.photos/seed/prod1-2/400/400",
      "https://picsum.photos/seed/prod1-3/400/400",
      "https://picsum.photos/seed/prod1-4/400/400"
    ],
    "weight": 9.19,
    "dimensions": {
      "width": 33.4,
      "height": 40,
      "depth": 14.6
    },
    "isAvailable": true,
    "isFeatured": false,
    "tags": [
      "backend"
    ],
    "createdAt": "2024-05-30T01:37:26.059Z",
    "updatedAt": "2026-12-15T02:55:19.943Z"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/categories/{id}/products'

fetch("https://api.rodin.dev/mock/categories/{id}/products", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/categories/{id}/products"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

comments

GET/comments

List all comments

Paginated list of comments. Supports filtering, range operators (`_gte`, `_lte`, `_gt`, `_lt`, `_ne`, `_like`), full-text search, sorting, field selection, and relation expansion.

Parameters 12

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsComment

Response examples

200Paginated array of comments

application/json example derived from schema

[
  {
    "id": 1,
    "postId": 1,
    "userId": 1,
    "body": "How does this compare to the approach described in the official docs?",
    "likes": 16,
    "createdAt": "2023-04-28T06:59:47.906Z"
  }
]

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/comments'

fetch("https://api.rodin.dev/mock/comments", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/comments"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/comments

Create comment

Create a new comment. Fields `id`, `createdAt`, `updatedAt` are auto-generated. Triggers `comments.created` webhook.

ReturnsComment

AcceptsCommentInput

Response examples

201Comment created

application/json example derived from schema

{
  "id": 1,
  "postId": 1,
  "userId": 1,
  "body": "How does this compare to the approach described in the official docs?",
  "likes": 16,
  "createdAt": "2023-04-28T06:59:47.906Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

413413 — body exceeds 64 KB

application/json

{
  "error": {
    "status": 413,
    "message": "Request body too large",
    "details": {
      "maxSize": "64 KB"
    }
  }
}

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "postId": 1,
  "userId": 2,
  "body": "Great write-up — saved me an hour of debugging."
}' 'https://api.rodin.dev/mock/comments'

fetch("https://api.rodin.dev/mock/comments", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"postId\": 1,\n  \"userId\": 2,\n  \"body\": \"Great write-up — saved me an hour of debugging.\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/comments"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"postId\": 1,\n  \"userId\": 2,\n  \"body\": \"Great write-up — saved me an hour of debugging.\"\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "postId": 1, "userId": 2, "body": "Great write-up — saved me an hour of debugging." }

GET/comments/{id}

Get comment by ID

Retrieve a single comment. Supports ETag conditional requests via `If-None-Match`.

Parameters 4

Name	Type	Description
_fields	query · string	Sparse fieldset — comma-separated fields to return. Leave blank for the full object.
_expand	query · string	Expand parent relations inline. Applies only when the resource has a matching parent (e.g. `user` on posts).
_embed	query · string	Embed child collections. Applies only when the resource has a matching child (e.g. `comments` on posts).

ReturnsComment

Response examples

200The comment

application/json example derived from schema

{
  "id": 1,
  "postId": 1,
  "userId": 1,
  "body": "How does this compare to the approach described in the official docs?",
  "likes": 16,
  "createdAt": "2023-04-28T06:59:47.906Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/comments/{id}'

fetch("https://api.rodin.dev/mock/comments/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/comments/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PUT/comments/{id}

Replace comment

Full replacement. All mutable fields overwritten. Triggers `comments.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsComment

AcceptsCommentInput

Response examples

200Comment replaced

application/json example derived from schema

{
  "id": 1,
  "postId": 1,
  "userId": 1,
  "body": "How does this compare to the approach described in the official docs?",
  "likes": 16,
  "createdAt": "2023-04-28T06:59:47.906Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PUT -H 'Content-Type: application/json' -d '{
  "postId": 1,
  "userId": 2,
  "body": "Great write-up — saved me an hour of debugging."
}' 'https://api.rodin.dev/mock/comments/{id}'

fetch("https://api.rodin.dev/mock/comments/{id}", {
  method: "PUT",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"postId\": 1,\n  \"userId\": 2,\n  \"body\": \"Great write-up — saved me an hour of debugging.\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/comments/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"postId\": 1,\n  \"userId\": 2,\n  \"body\": \"Great write-up — saved me an hour of debugging.\"\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "postId": 1, "userId": 2, "body": "Great write-up — saved me an hour of debugging." }

PATCH/comments/{id}

Partially update comment

Partial update — only provided fields change. Triggers `comments.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsComment

AcceptsCommentInput

Response examples

200Comment updated

application/json example derived from schema

{
  "id": 1,
  "postId": 1,
  "userId": 1,
  "body": "How does this compare to the approach described in the official docs?",
  "likes": 16,
  "createdAt": "2023-04-28T06:59:47.906Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "postId": 1,
  "userId": 2,
  "body": "Great write-up — saved me an hour of debugging."
}' 'https://api.rodin.dev/mock/comments/{id}'

fetch("https://api.rodin.dev/mock/comments/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"postId\": 1,\n  \"userId\": 2,\n  \"body\": \"Great write-up — saved me an hour of debugging.\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/comments/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"postId\": 1,\n  \"userId\": 2,\n  \"body\": \"Great write-up — saved me an hour of debugging.\"\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "postId": 1, "userId": 2, "body": "Great write-up — saved me an hour of debugging." }

DELETE/comments/{id}

Delete comment

Permanently remove a comment. Returns deleted resource. Triggers `comments.deleted` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsComment

Response examples

200Deleted comment

application/json example derived from schema

{
  "id": 1,
  "postId": 1,
  "userId": 1,
  "body": "How does this compare to the approach described in the official docs?",
  "likes": 16,
  "createdAt": "2023-04-28T06:59:47.906Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/comments/{id}'

fetch("https://api.rodin.dev/mock/comments/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/comments/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

database

GET/admin/report

Admin aggregate report

Read-only snapshot of record counts, active webhooks, and token count. Accepts either Bearer or Basic — the auth block in docs should show both alternatives.

ReturnsAdminReport

Response examples

200Report payload

application/json example derived from schema

{
  "generatedAt": "2024-01-15T09:30:00Z",
  "scheme": "bearer",
  "totals": {}
}

401401 — missing or expired Bearer token

application/json

{
  "error": {
    "status": 401,
    "message": "Authentication required"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/admin/report'

fetch("https://api.rodin.dev/mock/admin/report", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/admin/report"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/db/export

Export database

Full database as JSON. May be large.

Response examples

200Full dump

application/json example derived from schema

{}

Try It

Code examples

curl 'https://api.rodin.dev/mock/db/export'

fetch("https://api.rodin.dev/mock/db/export", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/db/export"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/db/reset

Reset database

Regenerate all data, clear tokens/webhooks/deliveries.

Try It

Code examples

curl -X POST 'https://api.rodin.dev/mock/db/reset'

fetch("https://api.rodin.dev/mock/db/reset", {
  method: "POST",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/db/reset"

response = requests.post(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/db/seed

Re-seed database

Regenerate with custom counts.

AcceptsSeedRequest

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "users": 0,
  "posts": 0,
  "comments": 0,
  "todos": 0
}' 'https://api.rodin.dev/mock/db/seed'

fetch("https://api.rodin.dev/mock/db/seed", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"users\": 0,\n  \"posts\": 0,\n  \"comments\": 0,\n  \"todos\": 0\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/db/seed"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"users\": 0,\n  \"posts\": 0,\n  \"comments\": 0,\n  \"todos\": 0\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "users": 0, "posts": 0, "comments": 0, "todos": 0 }

GET/db/stats

Database stats

ReturnsDbStats

Response examples

200Statistics

application/json example derived from schema

{
  "counts": {},
  "webhooks": 0,
  "deliveries": 0,
  "tokens": 0
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/db/stats'

fetch("https://api.rodin.dev/mock/db/stats", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/db/stats"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/openapi.json

OpenAPI spec

Try It

Code examples

curl 'https://api.rodin.dev/mock/openapi.json'

fetch("https://api.rodin.dev/mock/openapi.json", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/openapi.json"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

notifications

GET/notifications

List all notifications

Paginated list of notifications. Supports filtering, range operators (`_gte`, `_lte`, `_gt`, `_lt`, `_ne`, `_like`), full-text search, sorting, field selection, and relation expansion.

Parameters 12

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsNotification

Response examples

200Paginated array of notifications

application/json example derived from schema

[
  {
    "id": 1,
    "userId": 1,
    "type": "error",
    "title": "Error notification",
    "message": "New follower on your profile.",
    "read": true,
    "link": null,
    "createdAt": "2026-03-23T15:22:15.402Z"
  }
]

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/notifications'

fetch("https://api.rodin.dev/mock/notifications", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/notifications"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/notifications

Create notification

Create a new notification. Fields `id`, `createdAt`, `updatedAt` are auto-generated. Triggers `notifications.created` webhook.

ReturnsNotification

AcceptsNotificationInput

Response examples

201Notification created

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "type": "error",
  "title": "Error notification",
  "message": "New follower on your profile.",
  "read": true,
  "link": null,
  "createdAt": "2026-03-23T15:22:15.402Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

413413 — body exceeds 64 KB

application/json

{
  "error": {
    "status": 413,
    "message": "Request body too large",
    "details": {
      "maxSize": "64 KB"
    }
  }
}

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "type": "info",
  "title": "New feature available",
  "message": "Batch operations are now live — run up to 20 writes in one call.",
  "link": "/guide/batch"
}' 'https://api.rodin.dev/mock/notifications'

fetch("https://api.rodin.dev/mock/notifications", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"type\": \"info\",\n  \"title\": \"New feature available\",\n  \"message\": \"Batch operations are now live — run up to 20 writes in one call.\",\n  \"link\": \"/guide/batch\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/notifications"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"type\": \"info\",\n  \"title\": \"New feature available\",\n  \"message\": \"Batch operations are now live — run up to 20 writes in one call.\",\n  \"link\": \"/guide/batch\"\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "type": "info", "title": "New feature available", "message": "Batch operations are now live — run up to 20 writes in one call.", "link": "/guide/batch" }

GET/notifications/{id}

Get notification by ID

Retrieve a single notification. Supports ETag conditional requests via `If-None-Match`.

Parameters 4

Name	Type	Description
_fields	query · string	Sparse fieldset — comma-separated fields to return. Leave blank for the full object.
_expand	query · string	Expand parent relations inline. Applies only when the resource has a matching parent (e.g. `user` on posts).
_embed	query · string	Embed child collections. Applies only when the resource has a matching child (e.g. `comments` on posts).

ReturnsNotification

Response examples

200The notification

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "type": "error",
  "title": "Error notification",
  "message": "New follower on your profile.",
  "read": true,
  "link": null,
  "createdAt": "2026-03-23T15:22:15.402Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/notifications/{id}'

fetch("https://api.rodin.dev/mock/notifications/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/notifications/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PUT/notifications/{id}

Replace notification

Full replacement. All mutable fields overwritten. Triggers `notifications.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsNotification

AcceptsNotificationInput

Response examples

200Notification replaced

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "type": "error",
  "title": "Error notification",
  "message": "New follower on your profile.",
  "read": true,
  "link": null,
  "createdAt": "2026-03-23T15:22:15.402Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PUT -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "type": "info",
  "title": "New feature available",
  "message": "Batch operations are now live — run up to 20 writes in one call.",
  "link": "/guide/batch"
}' 'https://api.rodin.dev/mock/notifications/{id}'

fetch("https://api.rodin.dev/mock/notifications/{id}", {
  method: "PUT",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"type\": \"info\",\n  \"title\": \"New feature available\",\n  \"message\": \"Batch operations are now live — run up to 20 writes in one call.\",\n  \"link\": \"/guide/batch\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/notifications/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"type\": \"info\",\n  \"title\": \"New feature available\",\n  \"message\": \"Batch operations are now live — run up to 20 writes in one call.\",\n  \"link\": \"/guide/batch\"\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "type": "info", "title": "New feature available", "message": "Batch operations are now live — run up to 20 writes in one call.", "link": "/guide/batch" }

PATCH/notifications/{id}

Partially update notification

Partial update — only provided fields change. Triggers `notifications.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsNotification

AcceptsNotificationInput

Response examples

200Notification updated

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "type": "error",
  "title": "Error notification",
  "message": "New follower on your profile.",
  "read": true,
  "link": null,
  "createdAt": "2026-03-23T15:22:15.402Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "type": "info",
  "title": "New feature available",
  "message": "Batch operations are now live — run up to 20 writes in one call.",
  "link": "/guide/batch"
}' 'https://api.rodin.dev/mock/notifications/{id}'

fetch("https://api.rodin.dev/mock/notifications/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"type\": \"info\",\n  \"title\": \"New feature available\",\n  \"message\": \"Batch operations are now live — run up to 20 writes in one call.\",\n  \"link\": \"/guide/batch\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/notifications/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"type\": \"info\",\n  \"title\": \"New feature available\",\n  \"message\": \"Batch operations are now live — run up to 20 writes in one call.\",\n  \"link\": \"/guide/batch\"\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "type": "info", "title": "New feature available", "message": "Batch operations are now live — run up to 20 writes in one call.", "link": "/guide/batch" }

DELETE/notifications/{id}

Delete notification

Permanently remove a notification. Returns deleted resource. Triggers `notifications.deleted` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsNotification

Response examples

200Deleted notification

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "type": "error",
  "title": "Error notification",
  "message": "New follower on your profile.",
  "read": true,
  "link": null,
  "createdAt": "2026-03-23T15:22:15.402Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/notifications/{id}'

fetch("https://api.rodin.dev/mock/notifications/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/notifications/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

orders

GET/orders

List all orders

Paginated list of orders. Supports filtering, range operators (`_gte`, `_lte`, `_gt`, `_lt`, `_ne`, `_like`), full-text search, sorting, field selection, and relation expansion.

Parameters 12

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsOrder

Response examples

200Paginated array of orders

application/json example derived from schema

[
  {
    "id": 1,
    "userId": 1,
    "items": [
      {
        "productId": 37,
        "quantity": 2,
        "price": 416.97
      },
      {
        "productId": 16,
        "quantity": 2,
        "price": 478.87
      }
    ],
    "subtotal": 1791.68,
    "tax": 143.33,
    "shipping": 0,
    "total": 1935.01,
    "currency": "USD",
    "status": "pending",
    "paymentMethod": "credit_card",
    "shippingAddress": {
      "street": "6620 Maple Dr",
      "city": "Fort Worth",
      "state": "MI",
      "zipCode": "16372",
      "country": "US"
    },
    "trackingNumber": "TRK442765071",
    "notes": null,
    "createdAt": "2026-04-19T12:16:46.226Z",
    "updatedAt": "2025-01-30T04:10:54.855Z"
  }
]

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/orders'

fetch("https://api.rodin.dev/mock/orders", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/orders"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/orders

Create order

Create a new order. Fields `id`, `createdAt`, `updatedAt` are auto-generated. Triggers `orders.created` webhook.

ReturnsOrder

AcceptsOrderInput

Response examples

201Order created

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "items": [
    {
      "productId": 37,
      "quantity": 2,
      "price": 416.97
    },
    {
      "productId": 16,
      "quantity": 2,
      "price": 478.87
    }
  ],
  "subtotal": 1791.68,
  "tax": 143.33,
  "shipping": 0,
  "total": 1935.01,
  "currency": "USD",
  "status": "pending",
  "paymentMethod": "credit_card",
  "shippingAddress": {
    "street": "6620 Maple Dr",
    "city": "Fort Worth",
    "state": "MI",
    "zipCode": "16372",
    "country": "US"
  },
  "trackingNumber": "TRK442765071",
  "notes": null,
  "createdAt": "2026-04-19T12:16:46.226Z",
  "updatedAt": "2025-01-30T04:10:54.855Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

413413 — body exceeds 64 KB

application/json

{
  "error": {
    "status": 413,
    "message": "Request body too large",
    "details": {
      "maxSize": "64 KB"
    }
  }
}

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "items": [
    {
      "productId": 1,
      "quantity": 2,
      "price": 79.99
    },
    {
      "productId": 2,
      "quantity": 1,
      "price": 89
    }
  ],
  "subtotal": 248.98,
  "tax": 19.92,
  "shipping": 0,
  "total": 268.9,
  "currency": "USD",
  "paymentMethod": "credit_card",
  "shippingAddress": {
    "street": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "zip": "78701",
    "country": "US"
  }
}' 'https://api.rodin.dev/mock/orders'

fetch("https://api.rodin.dev/mock/orders", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"items\": [\n    {\n      \"productId\": 1,\n      \"quantity\": 2,\n      \"price\": 79.99\n    },\n    {\n      \"productId\": 2,\n      \"quantity\": 1,\n      \"price\": 89\n    }\n  ],\n  \"subtotal\": 248.98,\n  \"tax\": 19.92,\n  \"shipping\": 0,\n  \"total\": 268.9,\n  \"currency\": \"USD\",\n  \"paymentMethod\": \"credit_card\",\n  \"shippingAddress\": {\n    \"street\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"zip\": \"78701\",\n    \"country\": \"US\"\n  }\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/orders"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"items\": [\n    {\n      \"productId\": 1,\n      \"quantity\": 2,\n      \"price\": 79.99\n    },\n    {\n      \"productId\": 2,\n      \"quantity\": 1,\n      \"price\": 89\n    }\n  ],\n  \"subtotal\": 248.98,\n  \"tax\": 19.92,\n  \"shipping\": 0,\n  \"total\": 268.9,\n  \"currency\": \"USD\",\n  \"paymentMethod\": \"credit_card\",\n  \"shippingAddress\": {\n    \"street\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"zip\": \"78701\",\n    \"country\": \"US\"\n  }\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "items": [ { "productId": 1, "quantity": 2, "price": 79.99 }, { "productId": 2, "quantity": 1, "price": 89 } ], "subtotal": 248.98, "tax": 19.92, "shipping": 0, "total": 268.9, "currency": "USD", "paymentMethod": "credit_card", "shippingAddress": { "street": "123 Main St", "city": "Austin", "state": "TX", "zip": "78701", "country": "US" } }

GET/orders/{id}

Get order by ID

Retrieve a single order. Supports ETag conditional requests via `If-None-Match`.

Parameters 4

Name	Type	Description
_fields	query · string	Sparse fieldset — comma-separated fields to return. Leave blank for the full object.
_expand	query · string	Expand parent relations inline. Applies only when the resource has a matching parent (e.g. `user` on posts).
_embed	query · string	Embed child collections. Applies only when the resource has a matching child (e.g. `comments` on posts).

ReturnsOrder

Response examples

200The order

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "items": [
    {
      "productId": 37,
      "quantity": 2,
      "price": 416.97
    },
    {
      "productId": 16,
      "quantity": 2,
      "price": 478.87
    }
  ],
  "subtotal": 1791.68,
  "tax": 143.33,
  "shipping": 0,
  "total": 1935.01,
  "currency": "USD",
  "status": "pending",
  "paymentMethod": "credit_card",
  "shippingAddress": {
    "street": "6620 Maple Dr",
    "city": "Fort Worth",
    "state": "MI",
    "zipCode": "16372",
    "country": "US"
  },
  "trackingNumber": "TRK442765071",
  "notes": null,
  "createdAt": "2026-04-19T12:16:46.226Z",
  "updatedAt": "2025-01-30T04:10:54.855Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/orders/{id}'

fetch("https://api.rodin.dev/mock/orders/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/orders/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PUT/orders/{id}

Replace order

Full replacement. All mutable fields overwritten. Triggers `orders.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsOrder

AcceptsOrderInput

Response examples

200Order replaced

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "items": [
    {
      "productId": 37,
      "quantity": 2,
      "price": 416.97
    },
    {
      "productId": 16,
      "quantity": 2,
      "price": 478.87
    }
  ],
  "subtotal": 1791.68,
  "tax": 143.33,
  "shipping": 0,
  "total": 1935.01,
  "currency": "USD",
  "status": "pending",
  "paymentMethod": "credit_card",
  "shippingAddress": {
    "street": "6620 Maple Dr",
    "city": "Fort Worth",
    "state": "MI",
    "zipCode": "16372",
    "country": "US"
  },
  "trackingNumber": "TRK442765071",
  "notes": null,
  "createdAt": "2026-04-19T12:16:46.226Z",
  "updatedAt": "2025-01-30T04:10:54.855Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PUT -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "items": [
    {
      "productId": 1,
      "quantity": 2,
      "price": 79.99
    },
    {
      "productId": 2,
      "quantity": 1,
      "price": 89
    }
  ],
  "subtotal": 248.98,
  "tax": 19.92,
  "shipping": 0,
  "total": 268.9,
  "currency": "USD",
  "paymentMethod": "credit_card",
  "shippingAddress": {
    "street": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "zip": "78701",
    "country": "US"
  }
}' 'https://api.rodin.dev/mock/orders/{id}'

fetch("https://api.rodin.dev/mock/orders/{id}", {
  method: "PUT",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"items\": [\n    {\n      \"productId\": 1,\n      \"quantity\": 2,\n      \"price\": 79.99\n    },\n    {\n      \"productId\": 2,\n      \"quantity\": 1,\n      \"price\": 89\n    }\n  ],\n  \"subtotal\": 248.98,\n  \"tax\": 19.92,\n  \"shipping\": 0,\n  \"total\": 268.9,\n  \"currency\": \"USD\",\n  \"paymentMethod\": \"credit_card\",\n  \"shippingAddress\": {\n    \"street\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"zip\": \"78701\",\n    \"country\": \"US\"\n  }\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/orders/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"items\": [\n    {\n      \"productId\": 1,\n      \"quantity\": 2,\n      \"price\": 79.99\n    },\n    {\n      \"productId\": 2,\n      \"quantity\": 1,\n      \"price\": 89\n    }\n  ],\n  \"subtotal\": 248.98,\n  \"tax\": 19.92,\n  \"shipping\": 0,\n  \"total\": 268.9,\n  \"currency\": \"USD\",\n  \"paymentMethod\": \"credit_card\",\n  \"shippingAddress\": {\n    \"street\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"zip\": \"78701\",\n    \"country\": \"US\"\n  }\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "items": [ { "productId": 1, "quantity": 2, "price": 79.99 }, { "productId": 2, "quantity": 1, "price": 89 } ], "subtotal": 248.98, "tax": 19.92, "shipping": 0, "total": 268.9, "currency": "USD", "paymentMethod": "credit_card", "shippingAddress": { "street": "123 Main St", "city": "Austin", "state": "TX", "zip": "78701", "country": "US" } }

PATCH/orders/{id}

Partially update order

Partial update — only provided fields change. Triggers `orders.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsOrder

AcceptsOrderInput

Response examples

200Order updated

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "items": [
    {
      "productId": 37,
      "quantity": 2,
      "price": 416.97
    },
    {
      "productId": 16,
      "quantity": 2,
      "price": 478.87
    }
  ],
  "subtotal": 1791.68,
  "tax": 143.33,
  "shipping": 0,
  "total": 1935.01,
  "currency": "USD",
  "status": "pending",
  "paymentMethod": "credit_card",
  "shippingAddress": {
    "street": "6620 Maple Dr",
    "city": "Fort Worth",
    "state": "MI",
    "zipCode": "16372",
    "country": "US"
  },
  "trackingNumber": "TRK442765071",
  "notes": null,
  "createdAt": "2026-04-19T12:16:46.226Z",
  "updatedAt": "2025-01-30T04:10:54.855Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "items": [
    {
      "productId": 1,
      "quantity": 2,
      "price": 79.99
    },
    {
      "productId": 2,
      "quantity": 1,
      "price": 89
    }
  ],
  "subtotal": 248.98,
  "tax": 19.92,
  "shipping": 0,
  "total": 268.9,
  "currency": "USD",
  "paymentMethod": "credit_card",
  "shippingAddress": {
    "street": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "zip": "78701",
    "country": "US"
  }
}' 'https://api.rodin.dev/mock/orders/{id}'

fetch("https://api.rodin.dev/mock/orders/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"items\": [\n    {\n      \"productId\": 1,\n      \"quantity\": 2,\n      \"price\": 79.99\n    },\n    {\n      \"productId\": 2,\n      \"quantity\": 1,\n      \"price\": 89\n    }\n  ],\n  \"subtotal\": 248.98,\n  \"tax\": 19.92,\n  \"shipping\": 0,\n  \"total\": 268.9,\n  \"currency\": \"USD\",\n  \"paymentMethod\": \"credit_card\",\n  \"shippingAddress\": {\n    \"street\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"zip\": \"78701\",\n    \"country\": \"US\"\n  }\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/orders/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"items\": [\n    {\n      \"productId\": 1,\n      \"quantity\": 2,\n      \"price\": 79.99\n    },\n    {\n      \"productId\": 2,\n      \"quantity\": 1,\n      \"price\": 89\n    }\n  ],\n  \"subtotal\": 248.98,\n  \"tax\": 19.92,\n  \"shipping\": 0,\n  \"total\": 268.9,\n  \"currency\": \"USD\",\n  \"paymentMethod\": \"credit_card\",\n  \"shippingAddress\": {\n    \"street\": \"123 Main St\",\n    \"city\": \"Austin\",\n    \"state\": \"TX\",\n    \"zip\": \"78701\",\n    \"country\": \"US\"\n  }\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "items": [ { "productId": 1, "quantity": 2, "price": 79.99 }, { "productId": 2, "quantity": 1, "price": 89 } ], "subtotal": 248.98, "tax": 19.92, "shipping": 0, "total": 268.9, "currency": "USD", "paymentMethod": "credit_card", "shippingAddress": { "street": "123 Main St", "city": "Austin", "state": "TX", "zip": "78701", "country": "US" } }

DELETE/orders/{id}

Delete order

Permanently remove a order. Returns deleted resource. Triggers `orders.deleted` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsOrder

Response examples

200Deleted order

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "items": [
    {
      "productId": 37,
      "quantity": 2,
      "price": 416.97
    },
    {
      "productId": 16,
      "quantity": 2,
      "price": 478.87
    }
  ],
  "subtotal": 1791.68,
  "tax": 143.33,
  "shipping": 0,
  "total": 1935.01,
  "currency": "USD",
  "status": "pending",
  "paymentMethod": "credit_card",
  "shippingAddress": {
    "street": "6620 Maple Dr",
    "city": "Fort Worth",
    "state": "MI",
    "zipCode": "16372",
    "country": "US"
  },
  "trackingNumber": "TRK442765071",
  "notes": null,
  "createdAt": "2026-04-19T12:16:46.226Z",
  "updatedAt": "2025-01-30T04:10:54.855Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/orders/{id}'

fetch("https://api.rodin.dev/mock/orders/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/orders/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

photos

GET/photos

List all photos

Paginated list of photos. Supports filtering, range operators (`_gte`, `_lte`, `_gt`, `_lt`, `_ne`, `_like`), full-text search, sorting, field selection, and relation expansion.

Parameters 12

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsPhoto

Response examples

200Paginated array of photos

application/json example derived from schema

[
  {
    "id": 1,
    "albumId": 1,
    "title": "Photo 1",
    "url": "https://picsum.photos/seed/1/800/960",
    "thumbnailUrl": "https://picsum.photos/seed/1/150/150",
    "width": 800,
    "height": 960,
    "size": 4803273,
    "format": "jpeg",
    "createdAt": "2026-07-24T20:47:13.121Z"
  }
]

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/photos'

fetch("https://api.rodin.dev/mock/photos", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/photos"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/photos

Create photo

Create a new photo. Fields `id`, `createdAt`, `updatedAt` are auto-generated. Triggers `photos.created` webhook.

ReturnsPhoto

AcceptsPhotoInput

Response examples

201Photo created

application/json example derived from schema

{
  "id": 1,
  "albumId": 1,
  "title": "Photo 1",
  "url": "https://picsum.photos/seed/1/800/960",
  "thumbnailUrl": "https://picsum.photos/seed/1/150/150",
  "width": 800,
  "height": 960,
  "size": 4803273,
  "format": "jpeg",
  "createdAt": "2026-07-24T20:47:13.121Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

413413 — body exceeds 64 KB

application/json

{
  "error": {
    "status": 413,
    "message": "Request body too large",
    "details": {
      "maxSize": "64 KB"
    }
  }
}

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "albumId": 1,
  "title": "Sunset at Vík",
  "url": "https://picsum.photos/1600/1067?random=1",
  "thumbnailUrl": "https://picsum.photos/150/150?random=1",
  "width": 1600,
  "height": 1067,
  "format": "jpeg",
  "size": 284532
}' 'https://api.rodin.dev/mock/photos'

fetch("https://api.rodin.dev/mock/photos", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"albumId\": 1,\n  \"title\": \"Sunset at Vík\",\n  \"url\": \"https://picsum.photos/1600/1067?random=1\",\n  \"thumbnailUrl\": \"https://picsum.photos/150/150?random=1\",\n  \"width\": 1600,\n  \"height\": 1067,\n  \"format\": \"jpeg\",\n  \"size\": 284532\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/photos"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"albumId\": 1,\n  \"title\": \"Sunset at Vík\",\n  \"url\": \"https://picsum.photos/1600/1067?random=1\",\n  \"thumbnailUrl\": \"https://picsum.photos/150/150?random=1\",\n  \"width\": 1600,\n  \"height\": 1067,\n  \"format\": \"jpeg\",\n  \"size\": 284532\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "albumId": 1, "title": "Sunset at Vík", "url": "https://picsum.photos/1600/1067?random=1", "thumbnailUrl": "https://picsum.photos/150/150?random=1", "width": 1600, "height": 1067, "format": "jpeg", "size": 284532 }

GET/photos/{id}

Get photo by ID

Retrieve a single photo. Supports ETag conditional requests via `If-None-Match`.

Parameters 4

Name	Type	Description
_fields	query · string	Sparse fieldset — comma-separated fields to return. Leave blank for the full object.
_expand	query · string	Expand parent relations inline. Applies only when the resource has a matching parent (e.g. `user` on posts).
_embed	query · string	Embed child collections. Applies only when the resource has a matching child (e.g. `comments` on posts).

ReturnsPhoto

Response examples

200The photo

application/json example derived from schema

{
  "id": 1,
  "albumId": 1,
  "title": "Photo 1",
  "url": "https://picsum.photos/seed/1/800/960",
  "thumbnailUrl": "https://picsum.photos/seed/1/150/150",
  "width": 800,
  "height": 960,
  "size": 4803273,
  "format": "jpeg",
  "createdAt": "2026-07-24T20:47:13.121Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/photos/{id}'

fetch("https://api.rodin.dev/mock/photos/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/photos/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PUT/photos/{id}

Replace photo

Full replacement. All mutable fields overwritten. Triggers `photos.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsPhoto

AcceptsPhotoInput

Response examples

200Photo replaced

application/json example derived from schema

{
  "id": 1,
  "albumId": 1,
  "title": "Photo 1",
  "url": "https://picsum.photos/seed/1/800/960",
  "thumbnailUrl": "https://picsum.photos/seed/1/150/150",
  "width": 800,
  "height": 960,
  "size": 4803273,
  "format": "jpeg",
  "createdAt": "2026-07-24T20:47:13.121Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PUT -H 'Content-Type: application/json' -d '{
  "albumId": 1,
  "title": "Sunset at Vík",
  "url": "https://picsum.photos/1600/1067?random=1",
  "thumbnailUrl": "https://picsum.photos/150/150?random=1",
  "width": 1600,
  "height": 1067,
  "format": "jpeg",
  "size": 284532
}' 'https://api.rodin.dev/mock/photos/{id}'

fetch("https://api.rodin.dev/mock/photos/{id}", {
  method: "PUT",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"albumId\": 1,\n  \"title\": \"Sunset at Vík\",\n  \"url\": \"https://picsum.photos/1600/1067?random=1\",\n  \"thumbnailUrl\": \"https://picsum.photos/150/150?random=1\",\n  \"width\": 1600,\n  \"height\": 1067,\n  \"format\": \"jpeg\",\n  \"size\": 284532\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/photos/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"albumId\": 1,\n  \"title\": \"Sunset at Vík\",\n  \"url\": \"https://picsum.photos/1600/1067?random=1\",\n  \"thumbnailUrl\": \"https://picsum.photos/150/150?random=1\",\n  \"width\": 1600,\n  \"height\": 1067,\n  \"format\": \"jpeg\",\n  \"size\": 284532\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "albumId": 1, "title": "Sunset at Vík", "url": "https://picsum.photos/1600/1067?random=1", "thumbnailUrl": "https://picsum.photos/150/150?random=1", "width": 1600, "height": 1067, "format": "jpeg", "size": 284532 }

PATCH/photos/{id}

Partially update photo

Partial update — only provided fields change. Triggers `photos.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsPhoto

AcceptsPhotoInput

Response examples

200Photo updated

application/json example derived from schema

{
  "id": 1,
  "albumId": 1,
  "title": "Photo 1",
  "url": "https://picsum.photos/seed/1/800/960",
  "thumbnailUrl": "https://picsum.photos/seed/1/150/150",
  "width": 800,
  "height": 960,
  "size": 4803273,
  "format": "jpeg",
  "createdAt": "2026-07-24T20:47:13.121Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "albumId": 1,
  "title": "Sunset at Vík",
  "url": "https://picsum.photos/1600/1067?random=1",
  "thumbnailUrl": "https://picsum.photos/150/150?random=1",
  "width": 1600,
  "height": 1067,
  "format": "jpeg",
  "size": 284532
}' 'https://api.rodin.dev/mock/photos/{id}'

fetch("https://api.rodin.dev/mock/photos/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"albumId\": 1,\n  \"title\": \"Sunset at Vík\",\n  \"url\": \"https://picsum.photos/1600/1067?random=1\",\n  \"thumbnailUrl\": \"https://picsum.photos/150/150?random=1\",\n  \"width\": 1600,\n  \"height\": 1067,\n  \"format\": \"jpeg\",\n  \"size\": 284532\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/photos/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"albumId\": 1,\n  \"title\": \"Sunset at Vík\",\n  \"url\": \"https://picsum.photos/1600/1067?random=1\",\n  \"thumbnailUrl\": \"https://picsum.photos/150/150?random=1\",\n  \"width\": 1600,\n  \"height\": 1067,\n  \"format\": \"jpeg\",\n  \"size\": 284532\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "albumId": 1, "title": "Sunset at Vík", "url": "https://picsum.photos/1600/1067?random=1", "thumbnailUrl": "https://picsum.photos/150/150?random=1", "width": 1600, "height": 1067, "format": "jpeg", "size": 284532 }

DELETE/photos/{id}

Delete photo

Permanently remove a photo. Returns deleted resource. Triggers `photos.deleted` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsPhoto

Response examples

200Deleted photo

application/json example derived from schema

{
  "id": 1,
  "albumId": 1,
  "title": "Photo 1",
  "url": "https://picsum.photos/seed/1/800/960",
  "thumbnailUrl": "https://picsum.photos/seed/1/150/150",
  "width": 800,
  "height": 960,
  "size": 4803273,
  "format": "jpeg",
  "createdAt": "2026-07-24T20:47:13.121Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/photos/{id}'

fetch("https://api.rodin.dev/mock/photos/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/photos/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

posts

GET/posts

List all posts

Paginated list of posts. Supports filtering, range operators (`_gte`, `_lte`, `_gt`, `_lt`, `_ne`, `_like`), full-text search, sorting, field selection, and relation expansion.

Parameters 12

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsPost

Response examples

200Paginated array of posts

application/json example derived from schema

[
  {
    "id": 1,
    "userId": 1,
    "title": "Performance Optimization Tips",
    "slug": "web-security-fundamentals",
    "body": "Fusce commodo aliquam arcu. Nam commodo suscipit quam. Quisque id odio.\n\nCurabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra.",
    "excerpt": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliq...",
    "tags": [
      "ux"
    ],
    "status": "published",
    "views": 16848,
    "likes": 28,
    "featured": false,
    "coverImage": "https://picsum.photos/seed/1/800/400",
    "readingTime": 7,
    "createdAt": "2026-01-21T19:36:04.116Z",
    "updatedAt": "2026-01-21T19:36:04.116Z"
  }
]

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/posts'

fetch("https://api.rodin.dev/mock/posts", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/posts"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/posts

Create post

Create a new post. Fields `id`, `createdAt`, `updatedAt` are auto-generated. Triggers `posts.created` webhook.

ReturnsPost

AcceptsPostInput

Response examples

201Post created

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Performance Optimization Tips",
  "slug": "web-security-fundamentals",
  "body": "Fusce commodo aliquam arcu. Nam commodo suscipit quam. Quisque id odio.\n\nCurabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra.",
  "excerpt": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliq...",
  "tags": [
    "ux"
  ],
  "status": "published",
  "views": 16848,
  "likes": 28,
  "featured": false,
  "coverImage": "https://picsum.photos/seed/1/800/400",
  "readingTime": 7,
  "createdAt": "2026-01-21T19:36:04.116Z",
  "updatedAt": "2026-01-21T19:36:04.116Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

413413 — body exceeds 64 KB

application/json

{
  "error": {
    "status": 413,
    "message": "Request body too large",
    "details": {
      "maxSize": "64 KB"
    }
  }
}

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "title": "TypeScript tips I learned the hard way",
  "body": "First, never use `any`…",
  "excerpt": "Ten hard-won lessons from the trenches.",
  "tags": [
    "typescript",
    "engineering"
  ],
  "status": "draft"
}' 'https://api.rodin.dev/mock/posts'

fetch("https://api.rodin.dev/mock/posts", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"title\": \"TypeScript tips I learned the hard way\",\n  \"body\": \"First, never use `any`…\",\n  \"excerpt\": \"Ten hard-won lessons from the trenches.\",\n  \"tags\": [\n    \"typescript\",\n    \"engineering\"\n  ],\n  \"status\": \"draft\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/posts"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"title\": \"TypeScript tips I learned the hard way\",\n  \"body\": \"First, never use `any`…\",\n  \"excerpt\": \"Ten hard-won lessons from the trenches.\",\n  \"tags\": [\n    \"typescript\",\n    \"engineering\"\n  ],\n  \"status\": \"draft\"\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "title": "TypeScript tips I learned the hard way", "body": "First, never use `any`…", "excerpt": "Ten hard-won lessons from the trenches.", "tags": [ "typescript", "engineering" ], "status": "draft" }

GET/posts/{id}

Get post by ID

Retrieve a single post. Supports ETag conditional requests via `If-None-Match`.

Parameters 4

Name	Type	Description
_fields	query · string	Sparse fieldset — comma-separated fields to return. Leave blank for the full object.
_expand	query · string	Expand parent relations inline. Applies only when the resource has a matching parent (e.g. `user` on posts).
_embed	query · string	Embed child collections. Applies only when the resource has a matching child (e.g. `comments` on posts).

ReturnsPost

Response examples

200The post

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Performance Optimization Tips",
  "slug": "web-security-fundamentals",
  "body": "Fusce commodo aliquam arcu. Nam commodo suscipit quam. Quisque id odio.\n\nCurabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra.",
  "excerpt": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliq...",
  "tags": [
    "ux"
  ],
  "status": "published",
  "views": 16848,
  "likes": 28,
  "featured": false,
  "coverImage": "https://picsum.photos/seed/1/800/400",
  "readingTime": 7,
  "createdAt": "2026-01-21T19:36:04.116Z",
  "updatedAt": "2026-01-21T19:36:04.116Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/posts/{id}'

fetch("https://api.rodin.dev/mock/posts/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/posts/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PUT/posts/{id}deprecated

Replace post

Full replacement. All mutable fields overwritten. Triggers `posts.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsPost

AcceptsPostInput

Response examples

200Post replaced

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Performance Optimization Tips",
  "slug": "web-security-fundamentals",
  "body": "Fusce commodo aliquam arcu. Nam commodo suscipit quam. Quisque id odio.\n\nCurabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra.",
  "excerpt": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliq...",
  "tags": [
    "ux"
  ],
  "status": "published",
  "views": 16848,
  "likes": 28,
  "featured": false,
  "coverImage": "https://picsum.photos/seed/1/800/400",
  "readingTime": 7,
  "createdAt": "2026-01-21T19:36:04.116Z",
  "updatedAt": "2026-01-21T19:36:04.116Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PUT -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "title": "TypeScript tips I learned the hard way",
  "body": "First, never use `any`…",
  "excerpt": "Ten hard-won lessons from the trenches.",
  "tags": [
    "typescript",
    "engineering"
  ],
  "status": "draft"
}' 'https://api.rodin.dev/mock/posts/{id}'

fetch("https://api.rodin.dev/mock/posts/{id}", {
  method: "PUT",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"title\": \"TypeScript tips I learned the hard way\",\n  \"body\": \"First, never use `any`…\",\n  \"excerpt\": \"Ten hard-won lessons from the trenches.\",\n  \"tags\": [\n    \"typescript\",\n    \"engineering\"\n  ],\n  \"status\": \"draft\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/posts/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"title\": \"TypeScript tips I learned the hard way\",\n  \"body\": \"First, never use `any`…\",\n  \"excerpt\": \"Ten hard-won lessons from the trenches.\",\n  \"tags\": [\n    \"typescript\",\n    \"engineering\"\n  ],\n  \"status\": \"draft\"\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "title": "TypeScript tips I learned the hard way", "body": "First, never use `any`…", "excerpt": "Ten hard-won lessons from the trenches.", "tags": [ "typescript", "engineering" ], "status": "draft" }

PATCH/posts/{id}

Partially update post

Partial update — only provided fields change. Triggers `posts.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsPost

AcceptsPostInput

Response examples

200Post updated

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Performance Optimization Tips",
  "slug": "web-security-fundamentals",
  "body": "Fusce commodo aliquam arcu. Nam commodo suscipit quam. Quisque id odio.\n\nCurabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra.",
  "excerpt": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliq...",
  "tags": [
    "ux"
  ],
  "status": "published",
  "views": 16848,
  "likes": 28,
  "featured": false,
  "coverImage": "https://picsum.photos/seed/1/800/400",
  "readingTime": 7,
  "createdAt": "2026-01-21T19:36:04.116Z",
  "updatedAt": "2026-01-21T19:36:04.116Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "title": "TypeScript tips I learned the hard way",
  "body": "First, never use `any`…",
  "excerpt": "Ten hard-won lessons from the trenches.",
  "tags": [
    "typescript",
    "engineering"
  ],
  "status": "draft"
}' 'https://api.rodin.dev/mock/posts/{id}'

fetch("https://api.rodin.dev/mock/posts/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"title\": \"TypeScript tips I learned the hard way\",\n  \"body\": \"First, never use `any`…\",\n  \"excerpt\": \"Ten hard-won lessons from the trenches.\",\n  \"tags\": [\n    \"typescript\",\n    \"engineering\"\n  ],\n  \"status\": \"draft\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/posts/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"title\": \"TypeScript tips I learned the hard way\",\n  \"body\": \"First, never use `any`…\",\n  \"excerpt\": \"Ten hard-won lessons from the trenches.\",\n  \"tags\": [\n    \"typescript\",\n    \"engineering\"\n  ],\n  \"status\": \"draft\"\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "title": "TypeScript tips I learned the hard way", "body": "First, never use `any`…", "excerpt": "Ten hard-won lessons from the trenches.", "tags": [ "typescript", "engineering" ], "status": "draft" }

DELETE/posts/{id}

Delete post

Permanently remove a post. Returns deleted resource. Triggers `posts.deleted` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsPost

Response examples

200Deleted post

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Performance Optimization Tips",
  "slug": "web-security-fundamentals",
  "body": "Fusce commodo aliquam arcu. Nam commodo suscipit quam. Quisque id odio.\n\nCurabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra.",
  "excerpt": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliq...",
  "tags": [
    "ux"
  ],
  "status": "published",
  "views": 16848,
  "likes": 28,
  "featured": false,
  "coverImage": "https://picsum.photos/seed/1/800/400",
  "readingTime": 7,
  "createdAt": "2026-01-21T19:36:04.116Z",
  "updatedAt": "2026-01-21T19:36:04.116Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/posts/{id}'

fetch("https://api.rodin.dev/mock/posts/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/posts/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/posts/{id}/comments

List post's comments

Retrieve post's comments. Same filtering, sorting, and pagination as `/comments`.

Parameters 13

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsComment

Response examples

200Array of comments

application/json example derived from schema

[
  {
    "id": 1,
    "postId": 1,
    "userId": 1,
    "body": "How does this compare to the approach described in the official docs?",
    "likes": 16,
    "createdAt": "2023-04-28T06:59:47.906Z"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/posts/{id}/comments'

fetch("https://api.rodin.dev/mock/posts/{id}/comments", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/posts/{id}/comments"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

products

GET/products

List all products

Paginated list of products. Supports filtering, range operators (`_gte`, `_lte`, `_gt`, `_lt`, `_ne`, `_like`), full-text search, sorting, field selection, and relation expansion.

Parameters 12

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsProduct

Response examples

200Paginated array of products

application/json example derived from schema

[
  {
    "id": 1,
    "categoryId": 4,
    "name": "Desk Lamp",
    "description": "Ultra-fast connectivity with rock-solid reliability.",
    "price": 161.28,
    "originalPrice": 231.38,
    "currency": "USD",
    "stock": 257,
    "sku": "SKU-00001",
    "rating": 4.4,
    "reviewCount": 188,
    "image": "https://picsum.photos/seed/prod1/400/400",
    "images": [
      "https://picsum.photos/seed/prod1-0/400/400",
      "https://picsum.photos/seed/prod1-1/400/400",
      "https://picsum.photos/seed/prod1-2/400/400",
      "https://picsum.photos/seed/prod1-3/400/400",
      "https://picsum.photos/seed/prod1-4/400/400"
    ],
    "weight": 9.19,
    "dimensions": {
      "width": 33.4,
      "height": 40,
      "depth": 14.6
    },
    "isAvailable": true,
    "isFeatured": false,
    "tags": [
      "backend"
    ],
    "createdAt": "2024-05-30T01:37:26.059Z",
    "updatedAt": "2026-12-15T02:55:19.943Z"
  }
]

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/products'

fetch("https://api.rodin.dev/mock/products", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/products"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/products

Create product

Create a new product. Fields `id`, `createdAt`, `updatedAt` are auto-generated. Triggers `products.created` webhook.

ReturnsProduct

AcceptsProductInput

Response examples

201Product created

application/json example derived from schema

{
  "id": 1,
  "categoryId": 4,
  "name": "Desk Lamp",
  "description": "Ultra-fast connectivity with rock-solid reliability.",
  "price": 161.28,
  "originalPrice": 231.38,
  "currency": "USD",
  "stock": 257,
  "sku": "SKU-00001",
  "rating": 4.4,
  "reviewCount": 188,
  "image": "https://picsum.photos/seed/prod1/400/400",
  "images": [
    "https://picsum.photos/seed/prod1-0/400/400",
    "https://picsum.photos/seed/prod1-1/400/400",
    "https://picsum.photos/seed/prod1-2/400/400",
    "https://picsum.photos/seed/prod1-3/400/400",
    "https://picsum.photos/seed/prod1-4/400/400"
  ],
  "weight": 9.19,
  "dimensions": {
    "width": 33.4,
    "height": 40,
    "depth": 14.6
  },
  "isAvailable": true,
  "isFeatured": false,
  "tags": [
    "backend"
  ],
  "createdAt": "2024-05-30T01:37:26.059Z",
  "updatedAt": "2026-12-15T02:55:19.943Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

413413 — body exceeds 64 KB

application/json

{
  "error": {
    "status": 413,
    "message": "Request body too large",
    "details": {
      "maxSize": "64 KB"
    }
  }
}

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "categoryId": 1,
  "name": "Wireless earbuds",
  "price": 79.99,
  "sku": "SKU-01001",
  "stock": 100
}' 'https://api.rodin.dev/mock/products'

fetch("https://api.rodin.dev/mock/products", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"categoryId\": 1,\n  \"name\": \"Wireless earbuds\",\n  \"price\": 79.99,\n  \"sku\": \"SKU-01001\",\n  \"stock\": 100\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/products"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"categoryId\": 1,\n  \"name\": \"Wireless earbuds\",\n  \"price\": 79.99,\n  \"sku\": \"SKU-01001\",\n  \"stock\": 100\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "categoryId": 1, "name": "Wireless earbuds", "price": 79.99, "sku": "SKU-01001", "stock": 100 }

GET/products/{id}

Get product by ID

Retrieve a single product. Supports ETag conditional requests via `If-None-Match`.

Parameters 4

Name	Type	Description
_fields	query · string	Sparse fieldset — comma-separated fields to return. Leave blank for the full object.
_expand	query · string	Expand parent relations inline. Applies only when the resource has a matching parent (e.g. `user` on posts).
_embed	query · string	Embed child collections. Applies only when the resource has a matching child (e.g. `comments` on posts).

ReturnsProduct

Response examples

200The product

application/json example derived from schema

{
  "id": 1,
  "categoryId": 4,
  "name": "Desk Lamp",
  "description": "Ultra-fast connectivity with rock-solid reliability.",
  "price": 161.28,
  "originalPrice": 231.38,
  "currency": "USD",
  "stock": 257,
  "sku": "SKU-00001",
  "rating": 4.4,
  "reviewCount": 188,
  "image": "https://picsum.photos/seed/prod1/400/400",
  "images": [
    "https://picsum.photos/seed/prod1-0/400/400",
    "https://picsum.photos/seed/prod1-1/400/400",
    "https://picsum.photos/seed/prod1-2/400/400",
    "https://picsum.photos/seed/prod1-3/400/400",
    "https://picsum.photos/seed/prod1-4/400/400"
  ],
  "weight": 9.19,
  "dimensions": {
    "width": 33.4,
    "height": 40,
    "depth": 14.6
  },
  "isAvailable": true,
  "isFeatured": false,
  "tags": [
    "backend"
  ],
  "createdAt": "2024-05-30T01:37:26.059Z",
  "updatedAt": "2026-12-15T02:55:19.943Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/products/{id}'

fetch("https://api.rodin.dev/mock/products/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/products/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PUT/products/{id}

Replace product

Full replacement. All mutable fields overwritten. Triggers `products.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsProduct

AcceptsProductInput

Response examples

200Product replaced

application/json example derived from schema

{
  "id": 1,
  "categoryId": 4,
  "name": "Desk Lamp",
  "description": "Ultra-fast connectivity with rock-solid reliability.",
  "price": 161.28,
  "originalPrice": 231.38,
  "currency": "USD",
  "stock": 257,
  "sku": "SKU-00001",
  "rating": 4.4,
  "reviewCount": 188,
  "image": "https://picsum.photos/seed/prod1/400/400",
  "images": [
    "https://picsum.photos/seed/prod1-0/400/400",
    "https://picsum.photos/seed/prod1-1/400/400",
    "https://picsum.photos/seed/prod1-2/400/400",
    "https://picsum.photos/seed/prod1-3/400/400",
    "https://picsum.photos/seed/prod1-4/400/400"
  ],
  "weight": 9.19,
  "dimensions": {
    "width": 33.4,
    "height": 40,
    "depth": 14.6
  },
  "isAvailable": true,
  "isFeatured": false,
  "tags": [
    "backend"
  ],
  "createdAt": "2024-05-30T01:37:26.059Z",
  "updatedAt": "2026-12-15T02:55:19.943Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PUT -H 'Content-Type: application/json' -d '{
  "categoryId": 1,
  "name": "Wireless earbuds",
  "price": 79.99,
  "sku": "SKU-01001",
  "stock": 100
}' 'https://api.rodin.dev/mock/products/{id}'

fetch("https://api.rodin.dev/mock/products/{id}", {
  method: "PUT",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"categoryId\": 1,\n  \"name\": \"Wireless earbuds\",\n  \"price\": 79.99,\n  \"sku\": \"SKU-01001\",\n  \"stock\": 100\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/products/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"categoryId\": 1,\n  \"name\": \"Wireless earbuds\",\n  \"price\": 79.99,\n  \"sku\": \"SKU-01001\",\n  \"stock\": 100\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "categoryId": 1, "name": "Wireless earbuds", "price": 79.99, "sku": "SKU-01001", "stock": 100 }

PATCH/products/{id}

Partially update product

Partial update — only provided fields change. Triggers `products.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsProduct

AcceptsProductInput

Response examples

200Product updated

application/json example derived from schema

{
  "id": 1,
  "categoryId": 4,
  "name": "Desk Lamp",
  "description": "Ultra-fast connectivity with rock-solid reliability.",
  "price": 161.28,
  "originalPrice": 231.38,
  "currency": "USD",
  "stock": 257,
  "sku": "SKU-00001",
  "rating": 4.4,
  "reviewCount": 188,
  "image": "https://picsum.photos/seed/prod1/400/400",
  "images": [
    "https://picsum.photos/seed/prod1-0/400/400",
    "https://picsum.photos/seed/prod1-1/400/400",
    "https://picsum.photos/seed/prod1-2/400/400",
    "https://picsum.photos/seed/prod1-3/400/400",
    "https://picsum.photos/seed/prod1-4/400/400"
  ],
  "weight": 9.19,
  "dimensions": {
    "width": 33.4,
    "height": 40,
    "depth": 14.6
  },
  "isAvailable": true,
  "isFeatured": false,
  "tags": [
    "backend"
  ],
  "createdAt": "2024-05-30T01:37:26.059Z",
  "updatedAt": "2026-12-15T02:55:19.943Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "categoryId": 1,
  "name": "Wireless earbuds",
  "price": 79.99,
  "sku": "SKU-01001",
  "stock": 100
}' 'https://api.rodin.dev/mock/products/{id}'

fetch("https://api.rodin.dev/mock/products/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"categoryId\": 1,\n  \"name\": \"Wireless earbuds\",\n  \"price\": 79.99,\n  \"sku\": \"SKU-01001\",\n  \"stock\": 100\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/products/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"categoryId\": 1,\n  \"name\": \"Wireless earbuds\",\n  \"price\": 79.99,\n  \"sku\": \"SKU-01001\",\n  \"stock\": 100\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "categoryId": 1, "name": "Wireless earbuds", "price": 79.99, "sku": "SKU-01001", "stock": 100 }

DELETE/products/{id}

Delete product

Permanently remove a product. Returns deleted resource. Triggers `products.deleted` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsProduct

Response examples

200Deleted product

application/json example derived from schema

{
  "id": 1,
  "categoryId": 4,
  "name": "Desk Lamp",
  "description": "Ultra-fast connectivity with rock-solid reliability.",
  "price": 161.28,
  "originalPrice": 231.38,
  "currency": "USD",
  "stock": 257,
  "sku": "SKU-00001",
  "rating": 4.4,
  "reviewCount": 188,
  "image": "https://picsum.photos/seed/prod1/400/400",
  "images": [
    "https://picsum.photos/seed/prod1-0/400/400",
    "https://picsum.photos/seed/prod1-1/400/400",
    "https://picsum.photos/seed/prod1-2/400/400",
    "https://picsum.photos/seed/prod1-3/400/400",
    "https://picsum.photos/seed/prod1-4/400/400"
  ],
  "weight": 9.19,
  "dimensions": {
    "width": 33.4,
    "height": 40,
    "depth": 14.6
  },
  "isAvailable": true,
  "isFeatured": false,
  "tags": [
    "backend"
  ],
  "createdAt": "2024-05-30T01:37:26.059Z",
  "updatedAt": "2026-12-15T02:55:19.943Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/products/{id}'

fetch("https://api.rodin.dev/mock/products/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/products/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/products/{id}/reviews

List product's reviews

Retrieve product's reviews. Same filtering, sorting, and pagination as `/reviews`.

Parameters 13

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsReview

Response examples

200Array of reviews

application/json example derived from schema

[
  {
    "id": 1,
    "productId": 1,
    "userId": 1,
    "rating": 4,
    "title": "Works as advertised",
    "body": "Great article! Really helped me understand the concept better.",
    "isVerified": true,
    "helpful": 1,
    "createdAt": "2025-08-29T18:25:55.906Z"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/products/{id}/reviews'

fetch("https://api.rodin.dev/mock/products/{id}/reviews", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/products/{id}/reviews"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

reviews

GET/reviews

List all reviews

Paginated list of reviews. Supports filtering, range operators (`_gte`, `_lte`, `_gt`, `_lt`, `_ne`, `_like`), full-text search, sorting, field selection, and relation expansion.

Parameters 12

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsReview

Response examples

200Paginated array of reviews

application/json example derived from schema

[
  {
    "id": 1,
    "productId": 1,
    "userId": 1,
    "rating": 4,
    "title": "Works as advertised",
    "body": "Great article! Really helped me understand the concept better.",
    "isVerified": true,
    "helpful": 1,
    "createdAt": "2025-08-29T18:25:55.906Z"
  }
]

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/reviews'

fetch("https://api.rodin.dev/mock/reviews", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/reviews"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/reviews

Create review

Create a new review. Fields `id`, `createdAt`, `updatedAt` are auto-generated. Triggers `reviews.created` webhook.

ReturnsReview

AcceptsReviewInput

Response examples

201Review created

application/json example derived from schema

{
  "id": 1,
  "productId": 1,
  "userId": 1,
  "rating": 4,
  "title": "Works as advertised",
  "body": "Great article! Really helped me understand the concept better.",
  "isVerified": true,
  "helpful": 1,
  "createdAt": "2025-08-29T18:25:55.906Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

413413 — body exceeds 64 KB

application/json

{
  "error": {
    "status": 413,
    "message": "Request body too large",
    "details": {
      "maxSize": "64 KB"
    }
  }
}

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "productId": 1,
  "userId": 1,
  "rating": 5,
  "title": "Better than I expected",
  "body": "Quality is on par with gear twice the price. Would buy again.",
  "isVerified": true,
  "helpful": 12
}' 'https://api.rodin.dev/mock/reviews'

fetch("https://api.rodin.dev/mock/reviews", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"productId\": 1,\n  \"userId\": 1,\n  \"rating\": 5,\n  \"title\": \"Better than I expected\",\n  \"body\": \"Quality is on par with gear twice the price. Would buy again.\",\n  \"isVerified\": true,\n  \"helpful\": 12\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/reviews"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"productId\": 1,\n  \"userId\": 1,\n  \"rating\": 5,\n  \"title\": \"Better than I expected\",\n  \"body\": \"Quality is on par with gear twice the price. Would buy again.\",\n  \"isVerified\": true,\n  \"helpful\": 12\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "productId": 1, "userId": 1, "rating": 5, "title": "Better than I expected", "body": "Quality is on par with gear twice the price. Would buy again.", "isVerified": true, "helpful": 12 }

GET/reviews/{id}

Get review by ID

Retrieve a single review. Supports ETag conditional requests via `If-None-Match`.

Parameters 4

Name	Type	Description
_fields	query · string	Sparse fieldset — comma-separated fields to return. Leave blank for the full object.
_expand	query · string	Expand parent relations inline. Applies only when the resource has a matching parent (e.g. `user` on posts).
_embed	query · string	Embed child collections. Applies only when the resource has a matching child (e.g. `comments` on posts).

ReturnsReview

Response examples

200The review

application/json example derived from schema

{
  "id": 1,
  "productId": 1,
  "userId": 1,
  "rating": 4,
  "title": "Works as advertised",
  "body": "Great article! Really helped me understand the concept better.",
  "isVerified": true,
  "helpful": 1,
  "createdAt": "2025-08-29T18:25:55.906Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/reviews/{id}'

fetch("https://api.rodin.dev/mock/reviews/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/reviews/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PUT/reviews/{id}

Replace review

Full replacement. All mutable fields overwritten. Triggers `reviews.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsReview

AcceptsReviewInput

Response examples

200Review replaced

application/json example derived from schema

{
  "id": 1,
  "productId": 1,
  "userId": 1,
  "rating": 4,
  "title": "Works as advertised",
  "body": "Great article! Really helped me understand the concept better.",
  "isVerified": true,
  "helpful": 1,
  "createdAt": "2025-08-29T18:25:55.906Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PUT -H 'Content-Type: application/json' -d '{
  "productId": 1,
  "userId": 1,
  "rating": 5,
  "title": "Better than I expected",
  "body": "Quality is on par with gear twice the price. Would buy again.",
  "isVerified": true,
  "helpful": 12
}' 'https://api.rodin.dev/mock/reviews/{id}'

fetch("https://api.rodin.dev/mock/reviews/{id}", {
  method: "PUT",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"productId\": 1,\n  \"userId\": 1,\n  \"rating\": 5,\n  \"title\": \"Better than I expected\",\n  \"body\": \"Quality is on par with gear twice the price. Would buy again.\",\n  \"isVerified\": true,\n  \"helpful\": 12\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/reviews/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"productId\": 1,\n  \"userId\": 1,\n  \"rating\": 5,\n  \"title\": \"Better than I expected\",\n  \"body\": \"Quality is on par with gear twice the price. Would buy again.\",\n  \"isVerified\": true,\n  \"helpful\": 12\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "productId": 1, "userId": 1, "rating": 5, "title": "Better than I expected", "body": "Quality is on par with gear twice the price. Would buy again.", "isVerified": true, "helpful": 12 }

PATCH/reviews/{id}

Partially update review

Partial update — only provided fields change. Triggers `reviews.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsReview

AcceptsReviewInput

Response examples

200Review updated

application/json example derived from schema

{
  "id": 1,
  "productId": 1,
  "userId": 1,
  "rating": 4,
  "title": "Works as advertised",
  "body": "Great article! Really helped me understand the concept better.",
  "isVerified": true,
  "helpful": 1,
  "createdAt": "2025-08-29T18:25:55.906Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "productId": 1,
  "userId": 1,
  "rating": 5,
  "title": "Better than I expected",
  "body": "Quality is on par with gear twice the price. Would buy again.",
  "isVerified": true,
  "helpful": 12
}' 'https://api.rodin.dev/mock/reviews/{id}'

fetch("https://api.rodin.dev/mock/reviews/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"productId\": 1,\n  \"userId\": 1,\n  \"rating\": 5,\n  \"title\": \"Better than I expected\",\n  \"body\": \"Quality is on par with gear twice the price. Would buy again.\",\n  \"isVerified\": true,\n  \"helpful\": 12\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/reviews/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"productId\": 1,\n  \"userId\": 1,\n  \"rating\": 5,\n  \"title\": \"Better than I expected\",\n  \"body\": \"Quality is on par with gear twice the price. Would buy again.\",\n  \"isVerified\": true,\n  \"helpful\": 12\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "productId": 1, "userId": 1, "rating": 5, "title": "Better than I expected", "body": "Quality is on par with gear twice the price. Would buy again.", "isVerified": true, "helpful": 12 }

DELETE/reviews/{id}

Delete review

Permanently remove a review. Returns deleted resource. Triggers `reviews.deleted` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsReview

Response examples

200Deleted review

application/json example derived from schema

{
  "id": 1,
  "productId": 1,
  "userId": 1,
  "rating": 4,
  "title": "Works as advertised",
  "body": "Great article! Really helped me understand the concept better.",
  "isVerified": true,
  "helpful": 1,
  "createdAt": "2025-08-29T18:25:55.906Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/reviews/{id}'

fetch("https://api.rodin.dev/mock/reviews/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/reviews/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

todos

GET/todos

List all todos

Paginated list of todos. Supports filtering, range operators (`_gte`, `_lte`, `_gt`, `_lt`, `_ne`, `_like`), full-text search, sorting, field selection, and relation expansion.

Parameters 12

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsTodo

Response examples

200Paginated array of todos

application/json example derived from schema

[
  {
    "id": 1,
    "userId": 1,
    "title": "Configure monitoring",
    "completed": true,
    "priority": "low",
    "dueDate": null,
    "tags": [],
    "createdAt": "2024-01-25T00:38:32.919Z"
  }
]

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/todos'

fetch("https://api.rodin.dev/mock/todos", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/todos"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/todos

Create todo

Create a new todo. Fields `id`, `createdAt`, `updatedAt` are auto-generated. Triggers `todos.created` webhook.

ReturnsTodo

AcceptsTodoInput

Response examples

201Todo created

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Configure monitoring",
  "completed": true,
  "priority": "low",
  "dueDate": null,
  "tags": [],
  "createdAt": "2024-01-25T00:38:32.919Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

413413 — body exceeds 64 KB

application/json

{
  "error": {
    "status": 413,
    "message": "Request body too large",
    "details": {
      "maxSize": "64 KB"
    }
  }
}

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "title": "Reply to launch-day emails"
}' 'https://api.rodin.dev/mock/todos'

fetch("https://api.rodin.dev/mock/todos", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"title\": \"Reply to launch-day emails\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/todos"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"title\": \"Reply to launch-day emails\"\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "title": "Reply to launch-day emails" }

GET/todos/{id}

Get todo by ID

Retrieve a single todo. Supports ETag conditional requests via `If-None-Match`.

Parameters 4

Name	Type	Description
_fields	query · string	Sparse fieldset — comma-separated fields to return. Leave blank for the full object.
_expand	query · string	Expand parent relations inline. Applies only when the resource has a matching parent (e.g. `user` on posts).
_embed	query · string	Embed child collections. Applies only when the resource has a matching child (e.g. `comments` on posts).

ReturnsTodo

Response examples

200The todo

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Configure monitoring",
  "completed": true,
  "priority": "low",
  "dueDate": null,
  "tags": [],
  "createdAt": "2024-01-25T00:38:32.919Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/todos/{id}'

fetch("https://api.rodin.dev/mock/todos/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/todos/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PUT/todos/{id}

Replace todo

Full replacement. All mutable fields overwritten. Triggers `todos.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsTodo

AcceptsTodoInput

Response examples

200Todo replaced

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Configure monitoring",
  "completed": true,
  "priority": "low",
  "dueDate": null,
  "tags": [],
  "createdAt": "2024-01-25T00:38:32.919Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PUT -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "title": "Reply to launch-day emails"
}' 'https://api.rodin.dev/mock/todos/{id}'

fetch("https://api.rodin.dev/mock/todos/{id}", {
  method: "PUT",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"title\": \"Reply to launch-day emails\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/todos/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"title\": \"Reply to launch-day emails\"\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "title": "Reply to launch-day emails" }

PATCH/todos/{id}

Partially update todo

Partial update — only provided fields change. Triggers `todos.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsTodo

AcceptsTodoInput

Response examples

200Todo updated

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Configure monitoring",
  "completed": true,
  "priority": "low",
  "dueDate": null,
  "tags": [],
  "createdAt": "2024-01-25T00:38:32.919Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "userId": 1,
  "title": "Reply to launch-day emails"
}' 'https://api.rodin.dev/mock/todos/{id}'

fetch("https://api.rodin.dev/mock/todos/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"userId\": 1,\n  \"title\": \"Reply to launch-day emails\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/todos/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"userId\": 1,\n  \"title\": \"Reply to launch-day emails\"\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "userId": 1, "title": "Reply to launch-day emails" }

DELETE/todos/{id}

Delete todo

Permanently remove a todo. Returns deleted resource. Triggers `todos.deleted` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsTodo

Response examples

200Deleted todo

application/json example derived from schema

{
  "id": 1,
  "userId": 1,
  "title": "Configure monitoring",
  "completed": true,
  "priority": "low",
  "dueDate": null,
  "tags": [],
  "createdAt": "2024-01-25T00:38:32.919Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/todos/{id}'

fetch("https://api.rodin.dev/mock/todos/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/todos/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

users

GET/users

List all users

Paginated list of users. Supports filtering, range operators (`_gte`, `_lte`, `_gt`, `_lt`, `_ne`, `_like`), full-text search, sorting, field selection, and relation expansion.

Parameters 12

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsUser

Response examples

200Paginated array of users

application/json example derived from schema

[
  {
    "id": 1,
    "firstName": "Demo",
    "lastName": "User",
    "email": "demo@example.com",
    "username": "demo",
    "avatar": "https://i.pravatar.cc/150?u=demo",
    "phone": "+1-555-000-0001",
    "address": {
      "street": "1 Demo Way",
      "city": "Austin",
      "state": "TX",
      "zipCode": "78701",
      "country": "US",
      "geo": {
        "lat": 30.2672,
        "lng": -97.7431
      }
    },
    "company": {
      "name": "Demo Corp",
      "catchPhrase": "Seeded for docs and testing."
    },
    "website": "https://example.com/demo",
    "role": "admin",
    "age": 30,
    "bio": "Seeded demo account. Log in with any password.",
    "isActive": true,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2026-04-21T00:00:00.000Z"
  }
]

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/users'

fetch("https://api.rodin.dev/mock/users", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/users

Create user

Create a new user. Fields `id`, `createdAt`, `updatedAt` are auto-generated. Triggers `users.created` webhook.

ReturnsUser

AcceptsUserInput

Response examples

201User created

application/json example derived from schema

{
  "id": 1,
  "firstName": "Demo",
  "lastName": "User",
  "email": "demo@example.com",
  "username": "demo",
  "avatar": "https://i.pravatar.cc/150?u=demo",
  "phone": "+1-555-000-0001",
  "address": {
    "street": "1 Demo Way",
    "city": "Austin",
    "state": "TX",
    "zipCode": "78701",
    "country": "US",
    "geo": {
      "lat": 30.2672,
      "lng": -97.7431
    }
  },
  "company": {
    "name": "Demo Corp",
    "catchPhrase": "Seeded for docs and testing."
  },
  "website": "https://example.com/demo",
  "role": "admin",
  "age": 30,
  "bio": "Seeded demo account. Log in with any password.",
  "isActive": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2026-04-21T00:00:00.000Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

413413 — body exceeds 64 KB

application/json

{
  "error": {
    "status": 413,
    "message": "Request body too large",
    "details": {
      "maxSize": "64 KB"
    }
  }
}

429429 — rate limit exceeded (120/60s)

application/json

{
  "error": {
    "status": 429,
    "message": "Too many requests",
    "details": {
      "retryAfter": 45
    }
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com"
}' 'https://api.rodin.dev/mock/users'

fetch("https://api.rodin.dev/mock/users", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"email\": \"jane.doe@example.com\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"email\": \"jane.doe@example.com\"\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "firstName": "Jane", "lastName": "Doe", "email": "jane.doe@example.com" }

GET/users/{id}

Get user by ID

Retrieve a single user. Supports ETag conditional requests via `If-None-Match`.

Parameters 4

Name	Type	Description
_fields	query · string	Sparse fieldset — comma-separated fields to return. Leave blank for the full object.
_expand	query · string	Expand parent relations inline. Applies only when the resource has a matching parent (e.g. `user` on posts).
_embed	query · string	Embed child collections. Applies only when the resource has a matching child (e.g. `comments` on posts).

ReturnsUser

Response examples

200The user

application/json example derived from schema

{
  "id": 1,
  "firstName": "Demo",
  "lastName": "User",
  "email": "demo@example.com",
  "username": "demo",
  "avatar": "https://i.pravatar.cc/150?u=demo",
  "phone": "+1-555-000-0001",
  "address": {
    "street": "1 Demo Way",
    "city": "Austin",
    "state": "TX",
    "zipCode": "78701",
    "country": "US",
    "geo": {
      "lat": 30.2672,
      "lng": -97.7431
    }
  },
  "company": {
    "name": "Demo Corp",
    "catchPhrase": "Seeded for docs and testing."
  },
  "website": "https://example.com/demo",
  "role": "admin",
  "age": 30,
  "bio": "Seeded demo account. Log in with any password.",
  "isActive": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2026-04-21T00:00:00.000Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/users/{id}'

fetch("https://api.rodin.dev/mock/users/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PUT/users/{id}deprecated

Replace user

Full replacement. All mutable fields overwritten. Triggers `users.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsUser

AcceptsUserInput

Response examples

200User replaced

application/json example derived from schema

{
  "id": 1,
  "firstName": "Demo",
  "lastName": "User",
  "email": "demo@example.com",
  "username": "demo",
  "avatar": "https://i.pravatar.cc/150?u=demo",
  "phone": "+1-555-000-0001",
  "address": {
    "street": "1 Demo Way",
    "city": "Austin",
    "state": "TX",
    "zipCode": "78701",
    "country": "US",
    "geo": {
      "lat": 30.2672,
      "lng": -97.7431
    }
  },
  "company": {
    "name": "Demo Corp",
    "catchPhrase": "Seeded for docs and testing."
  },
  "website": "https://example.com/demo",
  "role": "admin",
  "age": 30,
  "bio": "Seeded demo account. Log in with any password.",
  "isActive": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2026-04-21T00:00:00.000Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PUT -H 'Content-Type: application/json' -d '{
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com"
}' 'https://api.rodin.dev/mock/users/{id}'

fetch("https://api.rodin.dev/mock/users/{id}", {
  method: "PUT",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"email\": \"jane.doe@example.com\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"email\": \"jane.doe@example.com\"\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "firstName": "Jane", "lastName": "Doe", "email": "jane.doe@example.com" }

PATCH/users/{id}

Partially update user

Partial update — only provided fields change. Triggers `users.updated` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsUser

AcceptsUserInput

Response examples

200User updated

application/json example derived from schema

{
  "id": 1,
  "firstName": "Demo",
  "lastName": "User",
  "email": "demo@example.com",
  "username": "demo",
  "avatar": "https://i.pravatar.cc/150?u=demo",
  "phone": "+1-555-000-0001",
  "address": {
    "street": "1 Demo Way",
    "city": "Austin",
    "state": "TX",
    "zipCode": "78701",
    "country": "US",
    "geo": {
      "lat": 30.2672,
      "lng": -97.7431
    }
  },
  "company": {
    "name": "Demo Corp",
    "catchPhrase": "Seeded for docs and testing."
  },
  "website": "https://example.com/demo",
  "role": "admin",
  "age": 30,
  "bio": "Seeded demo account. Log in with any password.",
  "isActive": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2026-04-21T00:00:00.000Z"
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com"
}' 'https://api.rodin.dev/mock/users/{id}'

fetch("https://api.rodin.dev/mock/users/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"email\": \"jane.doe@example.com\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"email\": \"jane.doe@example.com\"\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "firstName": "Jane", "lastName": "Doe", "email": "jane.doe@example.com" }

DELETE/users/{id}

Delete user

Permanently remove a user. Returns deleted resource. Triggers `users.deleted` webhook.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsUser

Response examples

200Deleted user

application/json example derived from schema

{
  "id": 1,
  "firstName": "Demo",
  "lastName": "User",
  "email": "demo@example.com",
  "username": "demo",
  "avatar": "https://i.pravatar.cc/150?u=demo",
  "phone": "+1-555-000-0001",
  "address": {
    "street": "1 Demo Way",
    "city": "Austin",
    "state": "TX",
    "zipCode": "78701",
    "country": "US",
    "geo": {
      "lat": 30.2672,
      "lng": -97.7431
    }
  },
  "company": {
    "name": "Demo Corp",
    "catchPhrase": "Seeded for docs and testing."
  },
  "website": "https://example.com/demo",
  "role": "admin",
  "age": 30,
  "bio": "Seeded demo account. Log in with any password.",
  "isActive": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2026-04-21T00:00:00.000Z"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/users/{id}'

fetch("https://api.rodin.dev/mock/users/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/users/{id}/albums

List user's albums

Retrieve user's albums. Same filtering, sorting, and pagination as `/albums`.

Parameters 13

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsAlbum

Response examples

200Array of albums

application/json example derived from schema

[
  {
    "id": 1,
    "userId": 1,
    "title": "Abstract",
    "description": "Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
    "coverImage": "https://picsum.photos/seed/album1/600/400",
    "photoCount": 39,
    "isPublic": true,
    "createdAt": "2024-07-02T09:01:49.954Z"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/users/{id}/albums'

fetch("https://api.rodin.dev/mock/users/{id}/albums", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users/{id}/albums"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/users/{id}/comments

List user's comments

Retrieve user's comments. Same filtering, sorting, and pagination as `/comments`.

Parameters 13

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsComment

Response examples

200Array of comments

application/json example derived from schema

[
  {
    "id": 1,
    "postId": 1,
    "userId": 1,
    "body": "How does this compare to the approach described in the official docs?",
    "likes": 16,
    "createdAt": "2023-04-28T06:59:47.906Z"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/users/{id}/comments'

fetch("https://api.rodin.dev/mock/users/{id}/comments", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users/{id}/comments"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/users/{id}/notifications

List user's notifications

Retrieve user's notifications. Same filtering, sorting, and pagination as `/notifications`.

Parameters 13

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsNotification

Response examples

200Array of notifications

application/json example derived from schema

[
  {
    "id": 1,
    "userId": 1,
    "type": "error",
    "title": "Error notification",
    "message": "New follower on your profile.",
    "read": true,
    "link": null,
    "createdAt": "2026-03-23T15:22:15.402Z"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/users/{id}/notifications'

fetch("https://api.rodin.dev/mock/users/{id}/notifications", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users/{id}/notifications"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/users/{id}/orders

List user's orders

Retrieve user's orders. Same filtering, sorting, and pagination as `/orders`.

Parameters 13

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsOrder

Response examples

200Array of orders

application/json example derived from schema

[
  {
    "id": 1,
    "userId": 1,
    "items": [
      {
        "productId": 37,
        "quantity": 2,
        "price": 416.97
      },
      {
        "productId": 16,
        "quantity": 2,
        "price": 478.87
      }
    ],
    "subtotal": 1791.68,
    "tax": 143.33,
    "shipping": 0,
    "total": 1935.01,
    "currency": "USD",
    "status": "pending",
    "paymentMethod": "credit_card",
    "shippingAddress": {
      "street": "6620 Maple Dr",
      "city": "Fort Worth",
      "state": "MI",
      "zipCode": "16372",
      "country": "US"
    },
    "trackingNumber": "TRK442765071",
    "notes": null,
    "createdAt": "2026-04-19T12:16:46.226Z",
    "updatedAt": "2025-01-30T04:10:54.855Z"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/users/{id}/orders'

fetch("https://api.rodin.dev/mock/users/{id}/orders", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users/{id}/orders"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/users/{id}/posts

List user's posts

Retrieve user's posts. Same filtering, sorting, and pagination as `/posts`.

Parameters 13

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsPost

Response examples

200Array of posts

application/json example derived from schema

[
  {
    "id": 1,
    "userId": 1,
    "title": "Performance Optimization Tips",
    "slug": "web-security-fundamentals",
    "body": "Fusce commodo aliquam arcu. Nam commodo suscipit quam. Quisque id odio.\n\nCurabitur pretium tincidunt lacus. Nulla gravida orci a odio. Nullam varius, turpis et commodo pharetra.",
    "excerpt": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliq...",
    "tags": [
      "ux"
    ],
    "status": "published",
    "views": 16848,
    "likes": 28,
    "featured": false,
    "coverImage": "https://picsum.photos/seed/1/800/400",
    "readingTime": 7,
    "createdAt": "2026-01-21T19:36:04.116Z",
    "updatedAt": "2026-01-21T19:36:04.116Z"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/users/{id}/posts'

fetch("https://api.rodin.dev/mock/users/{id}/posts", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users/{id}/posts"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/users/{id}/reviews

List user's reviews

Retrieve user's reviews. Same filtering, sorting, and pagination as `/reviews`.

Parameters 13

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsReview

Response examples

200Array of reviews

application/json example derived from schema

[
  {
    "id": 1,
    "productId": 1,
    "userId": 1,
    "rating": 4,
    "title": "Works as advertised",
    "body": "Great article! Really helped me understand the concept better.",
    "isVerified": true,
    "helpful": 1,
    "createdAt": "2025-08-29T18:25:55.906Z"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/users/{id}/reviews'

fetch("https://api.rodin.dev/mock/users/{id}/reviews", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users/{id}/reviews"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/users/{id}/todos

List user's tasks

Retrieve user's tasks. Same filtering, sorting, and pagination as `/todos`.

Parameters 13

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
_start	query · integer	Slice start index (alternative to page-based)

ReturnsTodo

Response examples

200Array of todos

application/json example derived from schema

[
  {
    "id": 1,
    "userId": 1,
    "title": "Configure monitoring",
    "completed": true,
    "priority": "low",
    "dueDate": null,
    "tags": [],
    "createdAt": "2024-01-25T00:38:32.919Z"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/users/{id}/todos'

fetch("https://api.rodin.dev/mock/users/{id}/todos", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/users/{id}/todos"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

utils

POST/batch

Batch operations

Up to 20 operations in one request, executed sequentially.

ReturnsBatchResult

AcceptsBatchOperation

Response examples

200Results

application/json example derived from schema

[
  {
    "status": 200,
    "body": {}
  }
]

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '[
  {
    "method": "GET",
    "url": "/users/1"
  }
]' 'https://api.rodin.dev/mock/batch'

fetch("https://api.rodin.dev/mock/batch", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "[\n  {\n    \"method\": \"GET\",\n    \"url\": \"/users/1\"\n  }\n]",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/batch"
headers = {
    "Content-Type": "application/json"
}
data = "[\n  {\n    \"method\": \"GET\",\n    \"url\": \"/users/1\"\n  }\n]"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

[ { "method": "GET", "url": "/users/1" } ]

GET/delay/{ms}

Delayed response

Wait N ms before responding. Test timeouts and loading states.

Parameters 1

Name	Type	Description
msrequired	path · integer

Response examples

200Delayed response

application/json example derived from schema

{
  "delayed": 0,
  "timestamp": "2024-01-15T09:30:00Z"
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/delay/{ms}'

fetch("https://api.rodin.dev/mock/delay/{ms}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/delay/{ms}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/echo

Echo request

Mirror request back as JSON.

ReturnsEchoResponse

Response examples

200Request mirror

application/json example derived from schema

{
  "method": "string",
  "url": "string",
  "headers": {},
  "query": {}
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/echo'

fetch("https://api.rodin.dev/mock/echo", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/echo"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/echo

Echo POST

Mirror the request body, query, and headers back — handy when you want to see exactly what your client is sending.

ReturnsEchoResponse

Response examples

200Request mirror

application/json example derived from schema

{
  "method": "string",
  "url": "string",
  "headers": {},
  "query": {}
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{}' 'https://api.rodin.dev/mock/echo'

fetch("https://api.rodin.dev/mock/echo", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/echo"
headers = {
    "Content-Type": "application/json"
}
data = "{}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{}

GET/health

Health check

ReturnsHealthCheck

Response examples

200Healthy

application/json example derived from schema

{
  "status": "ok",
  "uptime": 0,
  "timestamp": "2024-01-15T09:30:00Z"
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/health'

fetch("https://api.rodin.dev/mock/health", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/health"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/random/number

Random number(s)

Parameters 3

Name	Type	Description
min	query · integer
max	query · integer
count	query · integer

Try It

Code examples

curl 'https://api.rodin.dev/mock/random/number'

fetch("https://api.rodin.dev/mock/random/number", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/random/number"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/random/text

Lorem Ipsum

Parameters 1

Name	Type	Description
paragraphs	query · integer

Try It

Code examples

curl 'https://api.rodin.dev/mock/random/text'

fetch("https://api.rodin.dev/mock/random/text", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/random/text"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/random/uuid

Random UUID(s)

Parameters 1

Name	Type	Description
count	query · integer

Response examples

200UUID(s)

application/json example derived from schema

{
  "uuid": "00000000-0000-4000-8000-000000000000"
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/random/uuid'

fetch("https://api.rodin.dev/mock/random/uuid", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/random/uuid"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/status/{code}

Return HTTP status code

Test error handling with any status code.

Parameters 1

Name	Type	Description
coderequired	path · integer

Try It

Code examples

curl 'https://api.rodin.dev/mock/status/{code}'

fetch("https://api.rodin.dev/mock/status/{code}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/status/{code}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/stream

SSE event stream

Server-Sent Events — 1 event/sec, max 50. Test real-time UI and EventSource.

Response examples

200SSE stream

text/event-stream example derived from schema

"string"

Try It

Code examples

curl 'https://api.rodin.dev/mock/stream'

fetch("https://api.rodin.dev/mock/stream", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/stream"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/upload

Mock file upload

Simulates upload — no actual file storage. Accepts raw binary, multipart form, or JSON with a filename hint. Returns a fake CDN URL so your frontend can wire the full happy path without real object storage.

ReturnsUploadResponse

Response examples

201Upload response

application/json example derived from schema

{
  "id": "00000000-0000-4000-8000-000000000000",
  "filename": "document.pdf",
  "url": "https://example.com"
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "filename": "string"
}' 'https://api.rodin.dev/mock/upload'

fetch("https://api.rodin.dev/mock/upload", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"filename\": \"string\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/upload"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"filename\": \"string\"\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

webhooks

GET/webhooks

List webhooks

Parameters 2

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page

ReturnsWebhook

Response examples

200Webhook list

application/json example derived from schema

[
  {
    "id": 1,
    "url": "https://example.com/webhooks/receiver",
    "events": [
      "users.created",
      "orders.*"
    ]
  }
]

Try It

Code examples

curl 'https://api.rodin.dev/mock/webhooks'

fetch("https://api.rodin.dev/mock/webhooks", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/webhooks"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/webhooks

Register webhook

Subscribe URL to events. Patterns: `*` (all), `users.*`, `*.created`, `users.created`. Deliveries are simulated (logged, not sent).

ReturnsWebhook

AcceptsWebhookInput

Response examples

201Registered

application/json example derived from schema

{
  "id": 1,
  "url": "https://example.com/webhooks/receiver",
  "events": [
    "users.created",
    "orders.*"
  ]
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "url": "https://example.com",
  "events": [
    "string"
  ]
}' 'https://api.rodin.dev/mock/webhooks'

fetch("https://api.rodin.dev/mock/webhooks", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"url\": \"https://example.com\",\n  \"events\": [\n    \"string\"\n  ]\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/webhooks"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"url\": \"https://example.com\",\n  \"events\": [\n    \"string\"\n  ]\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "url": "https://example.com", "events": [ "string" ] }

GET/webhooks/{id}

Get webhook

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsWebhook

Response examples

200Webhook

application/json example derived from schema

{
  "id": 1,
  "url": "https://example.com/webhooks/receiver",
  "events": [
    "users.created",
    "orders.*"
  ]
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/webhooks/{id}'

fetch("https://api.rodin.dev/mock/webhooks/{id}", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/webhooks/{id}"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

PATCH/webhooks/{id}

Update webhook

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsWebhook

AcceptsWebhookInput

Response examples

200Updated

application/json example derived from schema

{
  "id": 1,
  "url": "https://example.com/webhooks/receiver",
  "events": [
    "users.created",
    "orders.*"
  ]
}

400400 — invalid input or malformed JSON

application/json

{
  "error": {
    "status": 400,
    "message": "Request body required"
  }
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X PATCH -H 'Content-Type: application/json' -d '{
  "url": "https://example.com",
  "events": [
    "string"
  ]
}' 'https://api.rodin.dev/mock/webhooks/{id}'

fetch("https://api.rodin.dev/mock/webhooks/{id}", {
  method: "PATCH",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"url\": \"https://example.com\",\n  \"events\": [\n    \"string\"\n  ]\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/webhooks/{id}"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"url\": \"https://example.com\",\n  \"events\": [\n    \"string\"\n  ]\n}"

response = requests.patch(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "url": "https://example.com", "events": [ "string" ] }

DELETE/webhooks/{id}

Delete webhook

Remove webhook and all delivery records.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsWebhook

Response examples

200Deleted

application/json example derived from schema

{
  "id": 1,
  "url": "https://example.com/webhooks/receiver",
  "events": [
    "users.created",
    "orders.*"
  ]
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X DELETE 'https://api.rodin.dev/mock/webhooks/{id}'

fetch("https://api.rodin.dev/mock/webhooks/{id}", {
  method: "DELETE",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/webhooks/{id}"

response = requests.delete(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

GET/webhooks/{id}/deliveries

Delivery history

Delivery log for a webhook — event, payload, simulated response, timing.

Parameters 3

Name	Type	Description
_page	query · integer	Page number (1-based)
_limit	query · integer	Items per page
idrequired	path · integer	Resource identifier

ReturnsWebhookDelivery

Response examples

200Deliveries

application/json example derived from schema

[
  {
    "id": 1,
    "webhookId": 1,
    "event": "users.created",
    "resource": "users"
  }
]

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl 'https://api.rodin.dev/mock/webhooks/{id}/deliveries'

fetch("https://api.rodin.dev/mock/webhooks/{id}/deliveries", {
  method: "GET",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/webhooks/{id}/deliveries"

response = requests.get(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POST/webhooks/{id}/test

Send test event

Trigger simulated `webhook.test` event.

Parameters 1

Name	Type	Description
idrequired	path · integer	Resource identifier

ReturnsWebhookDelivery

Response examples

200Test delivery

application/json example derived from schema

{
  "id": 1,
  "webhookId": 1,
  "event": "users.created",
  "resource": "users"
}

404404 — resource not found

application/json

{
  "error": {
    "status": 404,
    "message": "users #999 not found"
  }
}

Try It

Code examples

curl -X POST 'https://api.rodin.dev/mock/webhooks/{id}/test'

fetch("https://api.rodin.dev/mock/webhooks/{id}/test", {
  method: "POST",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mock/webhooks/{id}/test"

response = requests.post(url)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

POSTalbums.createdwebhook

Album created

Fired when a album is created.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockalbums.created'

fetch("https://api.rodin.dev/mockalbums.created", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockalbums.created"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTalbums.deletedwebhook

Album deleted

Fired when a album is deleted.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockalbums.deleted'

fetch("https://api.rodin.dev/mockalbums.deleted", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockalbums.deleted"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTalbums.updatedwebhook

Album updated

Fired when a album is updated.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockalbums.updated'

fetch("https://api.rodin.dev/mockalbums.updated", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockalbums.updated"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTcategories.createdwebhook

Category created

Fired when a category is created.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockcategories.created'

fetch("https://api.rodin.dev/mockcategories.created", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockcategories.created"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTcategories.deletedwebhook

Category deleted

Fired when a category is deleted.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockcategories.deleted'

fetch("https://api.rodin.dev/mockcategories.deleted", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockcategories.deleted"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTcategories.updatedwebhook

Category updated

Fired when a category is updated.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockcategories.updated'

fetch("https://api.rodin.dev/mockcategories.updated", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockcategories.updated"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTcomments.createdwebhook

Comment created

Fired when a comment is created.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockcomments.created'

fetch("https://api.rodin.dev/mockcomments.created", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockcomments.created"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTcomments.deletedwebhook

Comment deleted

Fired when a comment is deleted.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockcomments.deleted'

fetch("https://api.rodin.dev/mockcomments.deleted", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockcomments.deleted"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTcomments.updatedwebhook

Comment updated

Fired when a comment is updated.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockcomments.updated'

fetch("https://api.rodin.dev/mockcomments.updated", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockcomments.updated"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTnotifications.createdwebhook

Notification created

Fired when a notification is created.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mocknotifications.created'

fetch("https://api.rodin.dev/mocknotifications.created", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mocknotifications.created"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTnotifications.deletedwebhook

Notification deleted

Fired when a notification is deleted.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mocknotifications.deleted'

fetch("https://api.rodin.dev/mocknotifications.deleted", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mocknotifications.deleted"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTnotifications.updatedwebhook

Notification updated

Fired when a notification is updated.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mocknotifications.updated'

fetch("https://api.rodin.dev/mocknotifications.updated", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mocknotifications.updated"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTorders.createdwebhook

Order created

Fired when a order is created.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockorders.created'

fetch("https://api.rodin.dev/mockorders.created", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockorders.created"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTorders.deletedwebhook

Order deleted

Fired when a order is deleted.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockorders.deleted'

fetch("https://api.rodin.dev/mockorders.deleted", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockorders.deleted"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTorders.updatedwebhook

Order updated

Fired when a order is updated.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockorders.updated'

fetch("https://api.rodin.dev/mockorders.updated", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockorders.updated"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTphotos.createdwebhook

Photo created

Fired when a photo is created.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockphotos.created'

fetch("https://api.rodin.dev/mockphotos.created", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockphotos.created"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTphotos.deletedwebhook

Photo deleted

Fired when a photo is deleted.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockphotos.deleted'

fetch("https://api.rodin.dev/mockphotos.deleted", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockphotos.deleted"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTphotos.updatedwebhook

Photo updated

Fired when a photo is updated.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockphotos.updated'

fetch("https://api.rodin.dev/mockphotos.updated", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockphotos.updated"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTposts.createdwebhook

Post created

Fired when a post is created.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockposts.created'

fetch("https://api.rodin.dev/mockposts.created", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockposts.created"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTposts.deletedwebhook

Post deleted

Fired when a post is deleted.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockposts.deleted'

fetch("https://api.rodin.dev/mockposts.deleted", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockposts.deleted"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTposts.updatedwebhook

Post updated

Fired when a post is updated.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockposts.updated'

fetch("https://api.rodin.dev/mockposts.updated", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockposts.updated"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTproducts.createdwebhook

Product created

Fired when a product is created.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockproducts.created'

fetch("https://api.rodin.dev/mockproducts.created", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockproducts.created"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTproducts.deletedwebhook

Product deleted

Fired when a product is deleted.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockproducts.deleted'

fetch("https://api.rodin.dev/mockproducts.deleted", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockproducts.deleted"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTproducts.updatedwebhook

Product updated

Fired when a product is updated.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockproducts.updated'

fetch("https://api.rodin.dev/mockproducts.updated", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockproducts.updated"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTreviews.createdwebhook

Review created

Fired when a review is created.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockreviews.created'

fetch("https://api.rodin.dev/mockreviews.created", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockreviews.created"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTreviews.deletedwebhook

Review deleted

Fired when a review is deleted.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockreviews.deleted'

fetch("https://api.rodin.dev/mockreviews.deleted", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockreviews.deleted"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTreviews.updatedwebhook

Review updated

Fired when a review is updated.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockreviews.updated'

fetch("https://api.rodin.dev/mockreviews.updated", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockreviews.updated"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTtodos.createdwebhook

Todo created

Fired when a todo is created.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mocktodos.created'

fetch("https://api.rodin.dev/mocktodos.created", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mocktodos.created"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTtodos.deletedwebhook

Todo deleted

Fired when a todo is deleted.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mocktodos.deleted'

fetch("https://api.rodin.dev/mocktodos.deleted", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mocktodos.deleted"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTtodos.updatedwebhook

Todo updated

Fired when a todo is updated.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mocktodos.updated'

fetch("https://api.rodin.dev/mocktodos.updated", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mocktodos.updated"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTusers.createdwebhook

User created

Fired when a user is created.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockusers.created'

fetch("https://api.rodin.dev/mockusers.created", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockusers.created"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTusers.deletedwebhook

User deleted

Fired when a user is deleted.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockusers.deleted'

fetch("https://api.rodin.dev/mockusers.deleted", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockusers.deleted"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTusers.updatedwebhook

User updated

Fired when a user is updated.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockusers.updated'

fetch("https://api.rodin.dev/mockusers.updated", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockusers.updated"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }

POSTwebhook.testwebhook

Test ping

Fired via `POST /webhooks/{id}/test`.

AcceptsWebhookPayload

Try It

Code examples

curl -X POST -H 'Content-Type: application/json' -d '{
  "event": "users.created",
  "timestamp": "2024-01-15T09:30:00Z",
  "data": {}
}' 'https://api.rodin.dev/mockwebhook.test'

fetch("https://api.rodin.dev/mockwebhook.test", {
  method: "POST",
  headers: {
      "Content-Type": "application/json"
    },
  body: "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "https://api.rodin.dev/mockwebhook.test"
headers = {
    "Content-Type": "application/json"
}
data = "{\n  \"event\": \"users.created\",\n  \"timestamp\": \"2024-01-15T09:30:00Z\",\n  \"data\": {}\n}"

response = requests.post(url, headers=headers, data=data)
print(response.json())

Paste cURL

Server:

https://api.rodin.dev/mockhttp://localhost:3002

Body:

{ "event": "users.created", "timestamp": "2024-01-15T09:30:00Z", "data": {} }