GET
/
Organization
/
basic
/
{entry}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Organization/basic/{entry} \
  --header 'requestToken: <api-key>'
{
  "idOrg": 123,
  "orgParentId": 236,
  "orgName": "Pilgrim Planner",
  "orgParentName": "PropertyManager Pro",
  "orgType": 0,
  "orgId": 123,
  "orgWebsite": "www.pilgrimageplanner.com",
  "orgAddress": "123 Walnut Street",
  "orgCity": "Johnson City",
  "orgState": "TN",
  "orgZip": 37615,
  "orgCountry": "US",
  "orgTimezone": -5,
  "orgLogo": {
    "ftype": "pdf",
    "filename": "my-doc.pdf",
    "furl": "https://mysite.com/my-doc.pdf",
    "fContent": "TXkgdGVzdCBmaWxlHJ==..."
  },
  "replyToEmail": "example@email.com",
  "orgEntryName": "pilgrim-planner",
  "isRoot": false,
  "contacts": [
    {
      "contactName": "Herman Martinez",
      "contactEmail": "example@email.com",
      "contactTitle": "Owner",
      "contactPhone": "3055550000"
    }
  ],
  "billingInfo": {
    "achRouting": "123123123",
    "achAccount": "123123123",
    "billingAddress": "123 Walnut Street",
    "billingCity": "Johnson City",
    "billingState": "TN",
    "billingZip": "37615",
    "billingCountry": "US"
  },
  "hasBilling": true,
  "hasResidual": true,
  "createdAt": "2022-07-01 15:00:01",
  "services": [
    {
      "name": "<string>",
      "enabled": true,
      "description": "<string>",
      "reseller": true,
      "setupCost": 123,
      "monthlyCost": 123,
      "txPercentCost": 123,
      "txCost": 123
    }
  ],
  "users": [
    {
      "userId": 123,
      "Email": "example@email.com",
      "Name": "Sean Smith",
      "Phone": "5555555555",
      "snProvider": "google",
      "snIdentifier": null,
      "snData": null,
      "Scope": [
        {
          "orgType": 0,
          "orgId": 123,
          "orgEntry": "pilgrim-planner"
        }
      ],
      "Access": [
        {
          "roleLabel": "customers",
          "roleValue": true
        }
      ],
      "UsrStatus": 1,
      "language": "en",
      "timeZone": -5,
      "UsrMFA": false,
      "UsrMFAMode": 0,
      "createdAt": "2022-07-01 15:00:01",
      "lastAccess": "2022-07-01T15:00:01",
      "AdditionalData": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
      }
    }
  ],
  "summary": {
    "childOrgs": 123,
    "childPaypoints": 123,
    "countTx": 123,
    "amountTx": 123,
    "countSubs": 123,
    "amountSubs": 123
  },
  "recipientEmailNotification": true,
  "resumable": false
}

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
entry
string
required

The paypoint's entrypoint identifier. Learn more

Example:

"8cfec329267"

Response

200
application/json
Success
​
idOrg
integer | null

Organization ID. Unique identifier assigned to an org by Payabli.

Example:

123

​
orgParentId
integer

The ID of the org's parent organization.

Example:

236

​
orgName
string

The name of the organization.

Example:

"Pilgrim Planner"

​
orgParentName
string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

​
orgType
integer

The organization type. Currently, this must be 0.

Example:

0

​
orgId
integer | null

Organization ID. Unique identifier assigned to an org by Payabli.

Example:

123

​
orgWebsite
string | null

The organization's website.

Example:

"www.pilgrimageplanner.com"

​
orgAddress
string | null

The organization's address.

Example:

"123 Walnut Street"

​
orgCity
string | null

The organization's city.

Example:

"Johnson City"

​
orgState
string | null

The organization's state.

Example:

"TN"

​
orgZip
string | null

The organization's ZIP code.

Example:

37615

​
orgCountry
string | null

The organization's country.

Example:

"US"

​
orgTimezone
integer | null
default:0

The org's timezone, in UTC offset. For example, -5 is Eastern time.

Example:

-5

Contains details about a file. See See fileObject Object Model for a complete reference. Max upload size is 30 MB.

​
replyToEmail
string

Email address for organization-level communications, such as messages about why an application was declined. This is required by commerce laws in the US.

Example:

"example@email.com"

​
orgEntryName
string | null

The entryname for the org, in string format. If you leave this blank, Payabli uses the DBA name.

Example:

"pilgrim-planner"

​
isRoot
boolean | null

When true, indicates that this is the organization's root template.

Example:

false

​
contacts
object[] | null

List of contacts.

​
billingInfo
object
​
hasBilling
boolean | null
​
hasResidual
boolean | null
​
createdAt
string

Timestamp of when record was created, in UTC.

Example:

"2022-07-01 15:00:01"

​
services
object[] | null
​
users
object[] | null
​
summary
object
​
recipientEmailNotification
boolean
default:true

When true, Payabli will send the applicant a boarding link. Set this value to false if you are sending pre-filled applications via the API and don't want Payabli to send the applicant an email to complete the boarding application.

Example:

true

​
resumable
boolean
default:true

When true, the applicant can save an incomplete application and resume it later. When false, the applicant won't have an option to save their progress, and must complete the application in one session.

Example:

false

Was this page helpful?