Appearance
List a lookup table
GET /v1/admin/store/lookups/{table}
- Operation ID:
listStoreLookup - Tags: Store lookups
- Base URL:
http://localhost:8787
Lists genres, companies, platforms, languages or stores ordered by name. q filters by name; ids (comma-separated, max 100) resolves specific ids and is ignored for languages.
Workflow: Integration guide.
Authentication: staff Bearer JWT with permission store.read.
Authentication
- Auth: staff Bearer JWT (
Authorization: Bearer <access_token>) with the permissions below. - Required permissions:
store.read
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
table | path | string | yes | One of: "genres", "companies", "platforms", "languages", "stores" |
q | query | string | no | Max length: 200 |
ids | query | string | no | Pattern: ^\d+(,\d+)*$ |
page | query | integer | no | Default: 1. Min: 1 |
per_page | query | integer | no | Default: 25. Min: 1. Max: 100 |
Responses
200
Lookup rows page.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
data | (object (StoreLookupItem))[] | yes | - |
data[].id | integer | no | Absent on languages (keyed by code). |
data[].code | string | no | Languages only. |
data[].slug | string | no | Absent on languages. |
data[].name | string | yes | - |
data[].website | string | null | no | Companies only. |
data[].url | string | null | no | Stores only. |
data[].icon_path | string | null | no | Stores only. |
data[].created_at | string | no | ISO 8601 timestamp. |
data[].updated_at | string | no | ISO 8601 timestamp. |
meta | object | yes | - |
meta.page | integer | yes | Min: 1 |
meta.per_page | integer | yes | Min: 1. Max: 100 |
meta.total | integer | yes | Min: 0 |
Errors
400
Request validation failed.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ValidationErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | yes | One of: false |
error | object | yes | - |
error.name | string | yes | One of: "ZodError" |
error.issues | object[] | yes | - |
error.issues[].code | string | yes | - |
error.issues[].path | (string | number)[] | yes | - |
error.issues[].message | string | yes | - |
Request validation
json
{
"success": false,
"error": {
"name": "ZodError",
"issues": [
{
"code": "custom",
"path": [
"field"
],
"message": "Invalid value"
}
]
}
}401
Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Stable machine-readable error code, e.g. forbidden, not_found. |
details | any | no | Optional structured context. For 403 it is { perm }. |
Error response
json
{
"error": "missing_token"
}403
Authenticated but lacking the required permission. details.perm lists the accepted permission keys.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "forbidden",
"details": {
"perm": "store.read"
}
}500
Unexpected server error (internal). No details are returned.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "internal"
}Examples
curl
bash
curl -X GET 'http://localhost:8787/v1/admin/store/lookups/genres' \
-H "Authorization: Bearer $ACCESS_TOKEN"TypeScript
ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow
const response = await fetch("http://localhost:8787/v1/admin/store/lookups/genres", {
method: "GET",
headers: {
"Authorization": `Bearer ${accessToken}`,
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
? undefined
: response.headers.get("content-type")?.includes("json")
? await response.json()
: await response.text();