Payabli Organization API is one of 34 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Organization. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
7 operations
across 6 paths,
and defines 64 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.
7 operations6 paths64 schemas1 DELETE4 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.payabli.com/api
Authentication
HTTP Bearer, API Key
Resource Areas
1
Authentication & Security 2
Payabli Organization API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
An API key is passed in the header as requestToken (APIKeyAuth).
BearerAuth — OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
APIKeyAuth — Long-lived API token sent in the requestToken header. See [API token authentication](/developers/api-tokens).
Paths & Operations 7
Across 6 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Organization 7
POST
/Organization
Add organization
AddOrganization2 paramsbody→ 200400401500503
GET
/Organization/read/{orgId}
Get organization
GetOrganization2 params→ 200400401500503
GET
/Organization/basic/{entry}
Get basic organization details by entry name
GetBasicOrganization2 params→ 200400401500503
GET
/Organization/basicById/{orgId}
Get basic organization details by ID
GetBasicOrganizationById2 params→ 200400401500503
GET
/Organization/settings/{orgId}
Get organization settings
GetSettingsOrganization2 params→ 200400401500503
PUT
/Organization/{orgId}
Update organization
EditOrganization2 paramsbody→ 200400401500503
DELETE
/Organization/{orgId}
Delete organization
DeleteOrganization2 params→ 200400401500503
Schemas 64
The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are OrganizationQueryRecord (27 properties), OrganizationData (19 properties), AddOrganizationRequest (19 properties), UserQueryRecord (17 properties). Each schema is shown below with its type and property counts.
Orgtype
integer
The organization type. Currently, this must be 0.
Orgid
integer
Organization ID. Unique identifier assigned to an org by Payabli.
Orgzip
string
The organization's ZIP code.
UsrAccess
object
2 properties
KeyValue
object
3 properties
UserQueryRecord
object
17 properties
SettingsQueryRecord
object
6 properties
OrganizationData
object
19 properties
Contacts
object
5 properties
Instrument
object
7 properties2 required
Email
string
Email address.
OrgParentId
integer
The ID of the org's parent organization.
BillingAddressNullable
string
Billing address.
SummaryOrg
object
6 properties
ServiceCost
object
8 properties
FileContentFtype
string
The MIME type of the file (if content is provided).
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
MfaMode
integer
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
Orgentryname
string
The entryname for the org, in string format. If you leave this blank, Payabli uses the DBA name.
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Resumable
boolean
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 mus…
Optional but recommended. A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. Th…
BillingCityNullable
string
Billing city.
Orgcity
string
The organization's city.
AdditionalDataString
string
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage: json { "additionalData"…
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
OrgXScope
object
3 properties
BillingZip
string
Billing address ZIP code.
Responsedatanonobject
The response data.
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
NameUser
string
RecipientEmailNotification
boolean
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 Payab…
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties2 required
OrgParentName
string
The name of the parent organization.
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.
IsRoot
boolean
When true, indicates that this is the organization's root template.
ContactsField
array
List of contacts.
BillingCountryNullable
string
Billing address country.
Orgwebsite
string
The organization's website.
Mfa
boolean
When true, multi-factor authentication (MFA) is enabled.
Orgcountry
string
The organization's country.
Orgname
string
The name of the organization.
DeleteOrganizationResponse
object
3 properties1 required
Orgstate
string
The organization's state.
AddOrganizationResponse
object
3 properties1 required
AddOrganizationRequest
object
19 properties3 required
OrganizationQueryRecord
object
27 properties
CreatedAt
string
Timestamp of when record was created, in UTC.
Timezone
integer
Timezone, in UTC offset. For example, -5 is Eastern time.
ReadOnly
boolean
When true, the element is read-only.
BillingStateNullable
string
Billing state. Must be a 2-letter state code for addresses in the US.
Orgidstring
string
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".
Orgtimezone
integer
The org's timezone, in UTC offset. For example, -5 is Eastern time.
EditOrganizationResponse
object
5 properties2 required
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
Enabled
boolean
Toggles whether the section or element is enabled.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Payabli Organization API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
