API Docs/REST

API Reference

Auto-generated from your schema

Tables
GET/rest/v1/profiles

List all profiles

profiles テーブルからレコードの一覧を取得します。デフォルトでは最新 100 件が返されます。select / order / limit / offset のクエリパラメータで結果を絞り込めます。

Example request
import { createClient } from '@giraffe/client';

const giraffe = createClient(
  'https://kf82hs9.giraffe.app',
  'your-anon-key'
);

const { data, error } = await giraffe
  .from('profiles')
  .select('id, username, email, role')
  .order('created_at', { ascending: false })
  .limit(10);

console.log(data);
Query parameters
ParameterTypeDescription
selectstringComma-separated list of columns to return. Supports nested selects with foreign key joins.
orderstringColumn to sort by, with optional .asc or .desc suffix.
limitintMaximum number of rows to return. Default is 100.
offsetintNumber of rows to skip before returning results.
{column}filterFilter rows by column value using operators: eq, neq, gt, gte, lt, lte, like, ilike, is, in.
Headers
HeaderRequiredDescription
apikeyrequiredYour project's anon or service_role key for API authentication.
AuthorizationrequiredBearer token. Use the anon key for public access or a user JWT for RLS-protected queries.
Content-TypeoptionalSet to application/json for POST/PATCH requests.
PreferoptionalSet to return=representation to include the created/updated row in the response body.
Response
{
  "data": [
    {
      "id": "9f2e…a31c",
      "username": "hinata",
      "email": "hinata@acorn.dev",
      "full_name": "Hinata Mori",
      "avatar_url": "https:">//cdn/u/1.png",
      "role": "admin",
      "is_verified": true,
      "created_at": "2025-11-14T08:22:01+09:00"
    },
    {
      "id": "2c1d…b482",
      "username": "sora_k",
      "email": "sora.k@acorn.dev",
      "full_name": "Sora Kurosawa",
      "avatar_url": "https:">//cdn/u/2.png",
      "role": "member",
      "is_verified": true,
      "created_at": "2025-12-02T14:08:55+09:00"
    }
  ],
  "count": 12,
  "status": 200
}