Retrieve Organization Settings

Before You Begin

🔗 Use the GraphQL Playground to execute the queries in this guide.

➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.

Prerequisites

1. Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
2. Permissions: Ensure your token has permissions to view organization settings.
3. Organization ID: Identify the Organization where the card will be created.

Step 1: Find Your Organization ID

1. Via Pipefy UI

• Open the Organization in your browser.
• The URL will include the Organization ID: https://app.pipefy.com/organizations/123456789.
• Organization ID = 123456789 (the number after /organizations/).

2. Via GraphQL Query

• Refer to our Get resource IDs page for alternative methods.

Step 2: Query Organization Settings

Use the organizationSettings query to retrieve details about your organization's configuration. Below is an example:

{
  organizationSettings(id: "123") {
    id
    name
    displayPipefyBranding
    displayPipefyLogo
    customLogo
    onlyAdminCanCreatePipes
    onlyAdminCanInviteUsers
    closedCardTimersEnabled
    companyGuestCanCreatePipe
  }
}

Key Fields Explained:

• displayPipefyBranding: Indicates if Pipefy branding is visible.
• displayPipefyLogo: Shows if the Pipefy logo is displayed.
• customLogo: URL of the organization's custom logo (if set).
• onlyAdminCanCreatePipes: Restricts pipe creation to admins.
• onlyAdminCanInviteUsers: Restricts user invitation to admins.
• closedCardTimersEnabled: Controls whether timers are shown in closed cards.
• companyGuestCanCreatePipe: Allows company guests to create pipes.

Step 3: Execute and Interpret the Response

After running the query, you'll receive a structured JSON response. Here’s an example:

{
  "data": {
    "organizationSettings": {
      "id": "2",
      "name": "Pizzafy",
      "displayPipefyBranding": true,
      "displayPipefyLogo": true,
      "customLogo": "https://pipefy-...e28a19983a1a03eddcb3512dec4adf6b6b4056366f971",
      "onlyAdminCanCreatePipes": false,
      "onlyAdminCanInviteUsers": false,
      "closedCardTimersEnabled": true,
      "companyGuestCanCreatePipe": true
    }
  }
}

This query provides a quick and effective way to retrieve key organization configuration settings.