> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://beta-docs.payabli.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server.

# Get organization

GET https://api-sandbox.payabli.com/api/Organization/read/{orgId}

Retrieves details for an organization by ID. 

Reference: https://beta-docs.payabli.com/api-reference/organization/get-organization

## Authentication

- `requestToken` header (required) — API Key authentication via header

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Path parameters

- `orgId` (integer, required) — The numeric identifier for organization, assigned by Payabli.

## Response

### 200

Success

- `services` (list of OrganizationQueryRecordServicesItem, optional)
- `billingInfo` (Instrument, optional)
- `contacts` (list of Contacts, optional) — List of contacts.
- `createdAt` (datetime, optional) — Timestamp of when record was created, in UTC.
- `hasBilling` (boolean, optional)
- `hasResidual` (boolean, optional)
- `idOrg` (long, optional) — Organization ID. Unique identifier assigned to an org by Payabli.
- `isRoot` (boolean, optional) — When `true`, indicates that this is the organization's root template.
- `orgAddress` (string, optional) — The organization's address.
- `orgCity` (string, optional) — The organization's city.
- `orgCountry` (string, optional) — The organization's country.
- `orgEntryName` (string, optional) — The entryname for the org, in string format. If you leave this blank, Payabli uses the DBA name.
- `orgId` (long, optional) — Organization ID. Unique identifier assigned to an org by Payabli.
- `orgLogo` (FileContent, optional) — Contains details about a file. See See [fileObject Object Model](/api-reference/schemas/filecontent) for a complete reference. Max upload size is 30 MB.
- `orgName` (string, optional) — The name of the organization.
- `orgParentId` (long, optional) — The ID of the org's parent organization.
- `orgParentName` (string, optional) — The name of the parent organization.
- `orgState` (string, optional) — The organization's state.
- `orgTimezone` (integer, optional) — The org's timezone, in UTC offset. For example, -5 is Eastern time.
- `orgType` (integer, optional) — The organization type. Currently, this must be `0`.
- `orgWebsite` (string, optional) — The organization's website.
- `orgZip` (string, optional) — The organization's ZIP code.
- `recipientEmailNotification` (boolean, optional) — 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.
- `replyToEmail` (string, optional) — Email address for organization-level communications, such as messages about why an application was declined. This is required by commerce laws in the US.
- `resumable` (boolean, optional) — 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.
- `summary` (SummaryOrg, optional)
- `users` (list of UserQueryRecord, optional)

## Errors

### 400 Bad Request Error

Bad request/ invalid data

- `any`

### 401 Unauthorized Error

Unauthorized request.

- `any`

### 400 Bad Request Error

Bad request/ invalid data

- `any`

### 401 Unauthorized Error

Unauthorized request.

- `any`

### 500 Internal Server Error

Internal API Error

- `any`

### 503 Service Unavailable Error

Database connection error

- `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure.
- `responseData` (map from string to any, optional) — The object containing the response data.
- `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'.

## Types

### OrganizationQueryRecordServicesItem

- `description` (string, optional)
- `enabled` (boolean, optional)
- `monthlyCost` (double, optional)
- `name` (string, optional)
- `reseller` (boolean, optional)
- `setupCost` (double, optional)
- `txCost` (double, optional)
- `txPercentCost` (double, optional)

### Instrument

- `achAccount` (string, required) — Bank account number.
- `achRouting` (string, required) — ABA/routing number of Bank account.
- `billingAddress` (string, optional) — Billing address.
- `billingCity` (string, optional) — Billing city.
- `billingCountry` (string, optional) — Billing address country.
- `billingState` (string, optional) — Billing state. Must be 2-letter state code for address in US.
- `billingZip` (string, optional) — Billing address ZIP code.

### Contacts

- `contactEmail` (string, optional) — Contact email address.
- `contactName` (string, optional) — Contact name.
- `contactPhone` (string, optional) — Contact phone number.
- `contactTitle` (string, optional) — Contact title.

### FileContent

Contains details about a file. See See [fileObject Object Model](/api-reference/schemas/filecontent) for a complete reference. Max upload size is 30 MB.

- `fContent` (string, optional) — Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB.
- `filename` (string, optional) — The name of the attached file.
- `ftype` (enum, optional) — The MIME type of the file (if content is provided)
  - Allowed values: `pdf`, `doc`, `docx`, `jpg`, `jpeg`, `png`, `gif`, `txt`
- `furl` (string, optional) — Optional url provided to show or download the file remotely

### SummaryOrg

- `amountSubs` (double, optional)
- `amountTx` (double, optional)
- `childOrgs` (integer, optional)
- `childPaypoints` (integer, optional)
- `countSubs` (integer, optional)
- `countTx` (integer, optional)

### UserQueryRecord

- `Access` (list of UsrAccess, optional)
- `AdditionalData` (string, optional) — 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": { "key1": "value1", "key2": "value2", "key3": "value3" } } ```
- `createdAt` (datetime, optional) — The timestamp for the user's creation, in UTC.
- `Email` (string, optional) — The user's email address.
- `language` (string, optional) — The user's locale for PartnerHub and PayHub localization. Supported values: - `en` - `es`
- `lastAccess` (datetime, optional) — The timestamp for the user's last activity, in UTC.
- `Name` (string, optional)
- `Phone` (string, optional) — The user's phone number.
- `Scope` (list of OrgXScope, optional)
- `snData` (string, optional) — Additional data provided by the social network related to the customer.
- `snIdentifier` (string, optional) — Identifier or token for customer in linked social network.
- `snProvider` (string, optional) — Social network linked to customer. Possible values: facebook, google, twitter, microsoft.
- `timeZone` (integer, optional) — Timezone, in UTC offset. For example, -5 is Eastern time.
- `userId` (long, optional) — The user's ID in Payabli.
- `UsrMFA` (boolean, optional) — When `true`, multi-factor authentication (MFA) is enabled.
- `UsrMFAMode` (integer, optional)
- `UsrStatus` (integer, optional) — The user's status: - Inactive: 0 - Active: 1 - Deleted: -99 - Locked: 85

### UsrAccess

- `roleLabel` (string, optional)
- `roleValue` (boolean, optional)

### OrgXScope

- `orgEntry` (string, optional) — The entryname for the org, in string format. If you leave this blank, Payabli uses the DBA name.
- `orgId` (long, optional) — Organization ID. Unique identifier assigned to an org by Payabli.
- `orgType` (integer, optional) — The organization type. Currently, this must be `0`.

## Examples

**Response**

```json
{
  "services": [
    {
      "description": "description",
      "enabled": true,
      "monthlyCost": 1.1,
      "name": "name",
      "reseller": true,
      "setupCost": 1.1,
      "txCost": 1.1,
      "txPercentCost": 1.1
    }
  ],
  "billingInfo": {
    "achAccount": "123123123",
    "achRouting": "123123123",
    "billingAddress": "123 Walnut Street",
    "billingCity": "Johnson City",
    "billingCountry": "US",
    "billingState": "TN",
    "billingZip": "37615"
  },
  "contacts": [
    {
      "contactEmail": "example@email.com",
      "contactName": "Herman Martinez",
      "contactPhone": "3055550000",
      "contactTitle": "Owner"
    }
  ],
  "createdAt": "2022-07-01T15:00:01Z",
  "hasBilling": true,
  "hasResidual": true,
  "idOrg": 123,
  "isRoot": false,
  "orgAddress": "123 Walnut Street",
  "orgCity": "Johnson City",
  "orgCountry": "US",
  "orgEntryName": "pilgrim-planner",
  "orgId": 123,
  "orgLogo": {
    "fContent": "TXkgdGVzdCBmaWxlHJ==...",
    "filename": "my-doc.pdf",
    "ftype": "pdf",
    "furl": "https://mysite.com/my-doc.pdf"
  },
  "orgName": "Pilgrim Planner",
  "orgParentId": 236,
  "orgParentName": "PropertyManager Pro",
  "orgState": "TN",
  "orgTimezone": -5,
  "orgType": 0,
  "orgWebsite": "www.pilgrimageplanner.com",
  "orgZip": "orgZip",
  "recipientEmailNotification": true,
  "replyToEmail": "example@email.com",
  "resumable": false,
  "summary": {
    "amountSubs": 1.1,
    "amountTx": 1.1,
    "childOrgs": 1,
    "childPaypoints": 1,
    "countSubs": 1,
    "countTx": 1
  },
  "users": [
    {
      "Access": [
        {
          "roleValue": true
        }
      ],
      "AdditionalData": "AdditionalData",
      "createdAt": "2022-07-01T15:00:01Z",
      "Email": "example@email.com",
      "language": "en",
      "lastAccess": "2022-07-01T15:00:01Z",
      "Name": "Sean Smith",
      "Phone": "5555555555",
      "Scope": [
        {
          "orgType": 0
        }
      ],
      "snData": "snData",
      "snIdentifier": "snIdentifier",
      "snProvider": "google",
      "timeZone": -5,
      "userId": 1000000,
      "UsrMFA": false,
      "UsrMFAMode": 0,
      "UsrStatus": 1
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api-sandbox.payabli.com/api/Organization/read/123"

headers = {"requestToken": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api-sandbox.payabli.com/api/Organization/read/123';
const options = {method: 'GET', headers: {requestToken: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/Organization/read/123"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("requestToken", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Organization/read/123")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Organization/read/123")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Organization/read/123', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/Organization/read/123");
var request = new RestRequest(Method.GET);
request.AddHeader("requestToken", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Organization/read/123")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```