Get Organization Info

GET 
/organization

This endpoint returns the organization's info. It is used in many places across the UI. It returns the name in the navbar and the public key of the organization’s distribution account.

Responses

200

Returns organization details

application/json

Schema

Schema

name string
logo_url string
distribution_account_public_key string
timezone_utc_offset string
is_approval_required boolean

Enables multi-user approval workflow for disbursements

sms_registration_message_template string

The custom SMS message template set for the registration invite. The default message isn't returned. In the message's content it's possible to add the following template variables: {{.OrganizationName}} which is the Organization Name configured and {{.RegistrationLink}} which is the link generated by SDP to send to the receiver (in case this is not present in the message, it's automatically appended at the end).

otp_message_template string

The custom OTP message template set to send OTP code to the receiver complete the registration flow. The default message isn't returned. In the message's content it's possible to add the following template variables: {{.OrganizationName}} which is the Organization Name configured and {{.OTP}} which is the OTP code to send to the receiver complete the registration flow (in case this is not present in the message, it's automatically appended at the end).

Example (from schema)

{
  "name": "Stellar Aid",
  "logo_url": "https://stellar-disbursement-platform-backend-dev.stellar.org/organization/logo",
  "distribution_account_public_key": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL",
  "timezone_utc_offset": "+00:00",
  "is_approval_required": true,
  "sms_registration_message_template": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.",
  "otp_message_template": "{{.OTP}} is your {{.OrganizationName}} phone verification code."
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

error string
extras object
status number
message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

response

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

Loading...