本文へスキップ
CargoDuo logoCargoDuo
料金

このドキュメントは現在、英語版のみです。

開発者向けドキュメントAPI referenceProjects

List projects

Your organization's projects (the app's load plans), newest first, one page at a time.

GEThttps://runner.cargoduo.com/v1/projects

Free: no credits are charged.

認証

Bearer API キー(必要なスコープ)resources:read詳細を見る

クエリパラメーター

名前型必須説明
limitinteger
integer
いいえ

Page size.

デフォルト 201–100
cursorstring
string
いいえ

next_cursor of the previous page.

qstring
string
いいえ

Only projects whose name contains this text.

created_bystring
string
いいえ

Only what this member created: me (the key's creator) or a member id (usr_…).

リクエストの例

curl -X GET "https://runner.cargoduo.com/v1/projects?limit=2&created_by=me" \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

レスポンスの例

200 OK · ProjectList
{
  "data": [
    {
      "id": "prj_3051",
      "object": "project",
      "name": "Order 1042",
      "status": "calculated",
      "item_count": 58,
      "vehicle_count": 1,
      "app_url": "https://app.cargoduo.com/projects/3051",
      "created_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "updated_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "created_at": "2026-10-19T09:10:03Z",
      "updated_at": "2026-10-19T09:12:07Z"
    },
    {
      "id": "prj_3048",
      "object": "project",
      "name": "Order 1039",
      "status": "draft",
      "item_count": 24,
      "vehicle_count": 1,
      "app_url": "https://app.cargoduo.com/projects/3048",
      "created_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "updated_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "created_at": "2026-10-17T07:12:03Z",
      "updated_at": "2026-10-17T07:12:03Z"
    }
  ],
  "next_cursor": "prj_3048"
}

レスポンス

  • 200OKOne page of projects.
    名前型必須説明
    dataProjectSummary[]
    ProjectSummary[]
    いいえ

    Newest first.

    next_cursorstring
    string
    いいえ

    Pass as ?cursor= for the next page; empty on the last page.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedMissing, malformed or unknown API key.
    • key_revokedThe key was revoked.
    • key_expiredThe key passed its expiry date.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedThe calling IP is not on the key's allowlist.
    • subscription_inactiveThe organization has no active subscription that includes the API.
    • account_inactiveThe organization is suspended, or has no owner whose account is active.
    • scope_missingThe key lacks a scope this endpoint needs.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 422Unprocessable entityvalidation_failed
    • validation_failedThe request is well-formed JSON but describes an invalid job. details[] lists every problem.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 429Too many requestsrate_limited
    • rate_limitedToo many requests in the current minute, hour or day (per key or per organization), or more than 60 failed authentications per minute from your IP address.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 500Internal server errorinternal_error
    • internal_errorSomething failed on our side.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 503Service unavailableapi_disabled
    • api_disabledThe API is temporarily disabled (maintenance) or switched off for the organization.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード