全プロジェクトの詳細取得

説明

このAPIを使用すると、現在ログインしているCatalystユーザー（開発者やコラボレーターなど）のリモートコンソール内の全プロジェクトの詳細を取得できます。取得されるプロジェクトの詳細は、APIが実行されているCatalystアカウントと同じアカウントのものです。

リクエスト詳細

リクエストURL

GET

{api-domain}/baas/v1/project

copy

api-domain

URL

Catalyst APIにアクセスするためのDC固有ドメイン

リクエストヘッダー

Authorization: Zoho-oauthtoken {oauth_token}

任意のヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZOHOCATALYST.projects.Read

レスポンス詳細

レスポンスには、ユーザーがリモートコンソールで作成した全プロジェクトの詳細が含まれます。各プロジェクトのproject_domain_idやproject_domain_nameなどのプロジェクトドメイン詳細、および作成者のemail_idやuser_idなどのユーザー詳細が含まれます。

リクエスト例
copy

curl -X GET 

https://api.catalyst.zoho.com/baas/v1/project 

-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”

レスポンス例
copy
{
"status": "success",
"data": [
    {
        "platforms": [],
        "project_name": "BillingDesk",
        "created_by": {
            "zuid": 780776954,
            "is_confirmed": false,
            "email_id": "amelia.burrows@zylker.com",
            "first_name": "Amelia",
            "last_name": "Burrows",
            "user_type": "Admin",
            "user_id": 11811000000003003
        },
        "created_time": "Jun 04, 2023 04:19 PM",
        "redirect_url": "",
        "project_domain_details": {
            "project_domain_id": 10060895541,
            "project_domain_name": "billingdesk-781316834.development",
            "project_domain": "https://billingdesk-781316834.development.catalystserverless.com",
            "user_auth": {
                "userAuth": {},
                "createdTime": null,
                "createdBy": null
            },
            "mobile_auth": {}
        },
        "db_type": "SINGLE_DB",
        "id": 11811000000315013,
        "project_type": "Live",
        "env_details": [
            {
                "id": 11811000000315049,
                "env_name": "Development",
                "env_type": 3,
                "env_status": "Active",
                "project_details": {
                    "project_name": "BillingDesk",
                    "id": 11811000000315013,
                    "project_type": "Live"
                },
                "is_default": true,
                "env_zgid": "781316834",
                "action_required": false
            }
        ],
        "timezone": "Asia/Kolkata"
    },
    {
        "platforms": [],
        "project_name": "Zia",
        "created_by": {
            "zuid": 780776954,
            "is_confirmed": false,
            "email_id": "amelia.burrows@zylker.com",
            "first_name": "Amelia",
            "last_name": "Burrows",
            "user_type": "Admin",
            "user_id": 11811000000003003
        },
        "created_time": "Jun 02, 2023 11:55 AM",
        "redirect_url": "",
        "project_domain_details": {
            "project_domain_id": 10060816047,
            "project_domain_name": "zia-781316834.development",
            "project_domain": "https://zia-781316834.development.catalystserverless.com",
            "user_auth": {
                "userAuth": {},
                "createdTime": null,
                "createdBy": null
            },
            "mobile_auth": {}
        },
        "db_type": "SINGLE_DB",
        "id": 11811000000314001,
        "project_type": "Live",
        "env_details": [
            {
                "id": 11811000000314037,
                "env_name": "Development",
                "env_type": 3,
                "env_status": "Active",
                "project_details": {
                    "project_name": "Zia",
                    "id": 11811000000314001,
                    "project_type": "Live"
                },
                "is_default": true,
                "env_zgid": "781316834",
                "action_required": false
            }
        ],
        "timezone": "Asia/Kolkata"
    }

View more

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit