List projects

GET/v1/projectsRun

Any API key can call this.

Response (200)

dataarray of objectrequired

The returned object, or an array of objects for a list.

idstringrequired

The id of the project (prj_…).

Example: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with prj_.

namestringrequired

The name of the project.

Example: Kedai Kopi Senja

categorystring | nullrequired

The kind of business, as chosen when the project was made; null when not set.

Example: food_beverage

descriptionstring | nullrequired

What the project sells and who pays for it; null when not set.

Example: Order 1001

websitestring | nullrequired

The website of the project; null when not set.

Example: https://kopi.example.com

fee_bearerstringrequired

Who bears Baiyar's fee: merchant takes it out of what you receive, customer adds it to what the payer pays.

Example: merchant

Possible values: merchant, customer

default_payment_methodsarray of stringrequired

The methods a payment link of the project offers unless it narrows them.

statusstringrequired

active, inactive (switched off by you) or disabled (by Baiyar). Only an active project takes payments.

Example: active

Possible values: active, inactive, disabled

live_approvalstringrequired

not_submitted, in_review, needs_revision or approved. Only an approved project takes real payments.

Example: approved

Possible values: not_submitted, in_review, needs_revision, approved

created_atstringrequired

When this object was created (RFC 3339, UTC). Use it to sort objects by creation time.

Example: 2026-10-26T03:04:05.000Z

Format: date-time

metaobjectrequired

Request details such as its id and pagination cursor.

request_idstringrequired

The id of this request. Quote it when you ask support about it.

Example: req_Hy3k9QzT2LmN8vXa

A failed request answers with the common error shape; see Errors.

Request

curl "https://api.baiyar.com/v1/projects" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Response

{
  "data": [
    {
      "id": "prj_01k7q3m8x2v5t9n4b6c1d0e7fa",
      "name": "Kedai Kopi Senja",
      "category": "food_beverage",
      "description": "Order 1001",
      "website": "https://kopi.example.com",
      "fee_bearer": "merchant",
      "default_payment_methods": [
        "string"
      ],
      "status": "active",
      "live_approval": "approved",
      "created_at": "2026-10-26T03:04:05.000Z"
    }
  ],
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}