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

The response is of type object.