APIPay Ops endpointsBusiness entitiesOrganizations

Get organization

Retrieves details for an organization by ID.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

orgIdintegerRequired
The numeric identifier for organization, assigned by Payabli.

Response

Success
serviceslist of objects or null
billingInfoobject or null
contactslist of objects or null
List of contacts.
createdAtdatetime or null
Timestamp of when record was created, in UTC.
hasBillingboolean or null
hasResidualboolean or null
idOrglong or null
Organization ID. Unique identifier assigned to an org by Payabli.
isRootboolean or null

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

orgAddressstring or null
The organization's address.
orgCitystring or null
The organization's city.
orgCountrystring or null
The organization's country.
orgEntryNamestring or null
The entryname for the org, in string format. If you leave this blank, Payabli uses the DBA name.
orgIdstring or null
An alternate ID for the organization, in string format. This can be your internal identifier for an org, and is typically a name, like "My Suborganization".
orgNamestring or null
The name of the organization.
orgParentIdlong or null
The ID of the org's parent organization.
orgParentNamestring or null
The name of the parent organization.
orgStatestring or null
The organization's state.
orgTimezoneinteger or null

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

orgTypeinteger or null

The organization type. Currently, this must be 0.

orgWebsitestring or null
The organization's website.
orgZipstring or null
The organization's ZIP code.
recipientEmailNotificationboolean or null

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.

replyToEmailstring or nullformat: "email"

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

resumableboolean or null

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.

summaryobject or null
userslist of objects or null

Errors