Pigeon
  1. Organization
Pigeon
  • Introduction
  • Authentication
  • Integrations
  • Webhooks
  • Guides
    • How To Share Files via Pigeon
    • How To Create an E-Signature Request Item
    • How To Send Emails from Organization Addresses
  • Requests
    • Create Request
      POST
    • List Requests
      GET
    • Get Request
      GET
    • Delete Request
      DELETE
    • Update Request
      PATCH
    • Verify Request
      POST
    • Close Request
      POST
    • Duplicate Request
      POST
    • Reject Request (Request Changes)
      POST
    • Send Request Reminder
      POST
    • List Request Reminders
      GET
    • Get Request Activity Log
      GET
    • List Organization Requests
      GET
    • Update Request
      PATCH
    • Delete Request
      DELETE
  • Request Items
    • List Request Items
      GET
    • Get Request Item
      GET
    • Verify Request Item
      POST
    • Update Request Item
      PATCH
    • Delete Request Item
      DELETE
    • Create Request Item
      POST
  • Templates
    • Create Template
    • List Templates
    • Get Template
    • Delete Template
    • Update Template
    • List Organization Templates
  • Webhooks
    • Create Webhook Subscription
    • Get Webhook Subscription
    • List Webhook Subscriptions
    • Update Webhook Subscription
    • Delete Webhook Subscription
  • Files
    • Download Request Files
    • Download Request Item Files
    • Download File
    • Get Request Files
    • Get Request Item Files
    • Delete File
  • Request Attachments
    • Upload Attachment
    • List Item Attachments
    • Get Attachment
    • Download Attachment
    • Delete Attachment
  • File Sharing
    • Initialize File Sharing Session
    • Upload File
    • Share Files
    • List File Sharing Sessions
    • Get File Sharing Session
    • Update File Sharing Session
    • Delete File Sharing Session
  • E-Signature / Document Forms
    • Create New E-Signature Document
    • Update E-Signature Document
    • Get E-Signature Document
    • List E-Signature Documents
    • Delete E-Signature Document
  • Users
    • List Users
    • Get User
    • Get Current User
  • Cloud Storage
    • List Cloud Storage Providers
    • Connect Cloud Storage Providers
    • Disconnect Cloud Storage Provider
  • Branding
    • Get Organization Branding
    • Update Organization Branding
  • Confirmation Page
    • Enable/Disable Signature Confirmation Page
  • Organization
    • Get Organization Settings
      GET
    • Update Organization Settings
      PATCH
  • RequestItems
    • Create Request Item
    • List Request Items
    • Get Request Item
    • Update Request Item
    • Delete Request Item
    • Verify Request Item
  • Documents
    • Get Document
    • Delete Document
    • List Request Documents
    • Delete Request Documents
    • List Request Item Documents
    • Download Document
    • Download Request Documents
    • Download Request Item Documents
  1. Organization

Get Organization Settings

GET
/organizations/{id}/settings
Retrieve the settings configuration for an organization.

Request

Path Params
id
string 
required
Organization ID

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/organizations//settings'

Responses

🟢200Success
application/json
Body
id
string 
required
Organization ID
branding
object (OrganizationBranding) 
optional
Custom branding configuration for organization.
colors
object 
optional
logoUrl
string 
optional
Media URL for organization's logo
logoWidth
integer 
optional
Width in pixel of organization's logo
defaultStorageProvider
enum<string> 
optional
Default cloud storage provider where all uploaded data will be stored.
Allowed values:
GOOGLE_DRIVEPIGEON
sharedDashboard
boolean 
optional
sharedContacts
boolean 
optional
convertImagesToPdf
boolean 
optional
dueDateGracePeriod
integer 
optional
defaultVDSPeriod
integer 
optional
maxVDSPeriod
integer 
optional
defaultSendMethod
enum<string> 
optional
Allowed values:
DEFAULTEMAILSMSBOTHMULTIPLE
defaultAuthMethod
object (AuthenticationMethod) 
optional
type
enum<string> 
required
Authentication method
Allowed values:
EMAIL_ACCESS_CODESMS_ACCESS_CODESECURITY_QUESTION
questionText
string 
optional
Security question text. Required if type set to SECURITY_QUESTION
questionAnswer
string 
optional
Correct, expected answer to the security question. Required if type set to SECURITY_QUESTION
disallowedFileExtensions
array[string]
optional
displaySignatureConfirmationPage
boolean 
optional
Indicates whether or not a confirmation page should be appended to e-signature sessions. Defaults to false.
sendEmailsFromUserAddress
boolean 
optional
Indicates wheteher Pigeon transactional emails are sent from the user creating a request. When false, emails are sent from no-reply@pigeondocuments.com. Defaults to false.
Default:
false
Example
{
  "id": "et eiusmod tempor dolore Excepteur",
  "branding": {
    "colors": {
      "primary": "#00000",
      "secondary": "#ffffff"
    },
    "logoUrl": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgYmFzZVByb2ZpbGU9ImZ1bGwiIHdpZHRoPSIyNDEiIGhlaWdodD0iMzcyNyI+PHJlY3Qgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAwJSIgZmlsbD0iIzBmY2VmZCIvPjx0ZXh0IHg9IjEyMC41IiB5PSIxODYzLjUiIGZvbnQtc2l6ZT0iMjAiIGFsaWdubWVudC1iYXNlbGluZT0ibWlkZGxlIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmaWxsPSJ3aGl0ZSI+MjQxeDM3Mjc8L3RleHQ+PC9zdmc+"
  },
  "defaultStorageProvider": "GOOGLE_DRIVE",
  "sharedDashboard": false,
  "sharedContacts": false,
  "convertImagesToPdf": false,
  "dueDateGracePeriod": -33827318,
  "defaultVDSPeriod": 68913665,
  "maxVDSPeriod": -28423671,
  "defaultSendMethod": "EMAIL",
  "defaultAuthMethod": {
    "type": "SMS_ACCESS_CODE",
    "questionText": "eu laborum sit",
    "questionAnswer": "occaecat enim"
  },
  "disallowedFileExtensions": [
    "enim irure eu",
    "magna pariatur sed adipisicing anim",
    "adipisicing veniam culpa"
  ],
  "displayPostSignatureConfirmation": false
}
🟠404Record Not Found
Modified at 2024-10-29 16:12:15
Previous
Enable/Disable Signature Confirmation Page
Next
Update Organization Settings