> This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md

# Get an organization

GET https://api-sandbox.payabli.com/api/v2/organizations/{organizationReference}

Retrieves an organization by reference.

Reference: https://docs.payabli.com/developers/api-reference/organizations/get-an-organization

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

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

## Request

### Path parameters

- `organizationReference` (string, required) — The organization reference.

## Response

### 200

The organization.

- `success` (boolean, required) — Whether the request succeeded.
- `message` (string, required, nullable) — A human-readable result message.
- `traceId` (string, required, nullable) — The trace identifier for the request, useful for support.
- `data` (PaypointDetailResponse, required, nullable) — The paypoint detail.

## Errors

### 401 Unauthorized Error

Unauthorized request.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

### 404 Not Found Error

The requested resource wasn't found.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

### 500 Internal Server Error

Internal server error.

- `isSuccess` (boolean, required) — Always `false` for error responses.
- `responseText` (string, required) — Error text describing what went wrong.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
- `responseData` (PayabliErrorBodyResponseData, optional) — Object with detailed error context.

## Types

### PaypointDetailResponse

The full detail of a paypoint.

- `paypointReference` (string, required) — The paypoint reference.
- `parentPaypointReference` (string, required) — The reference of the parent paypoint this paypoint nests under. For a merchant boarded directly under an organization, this is the organization, which is itself a paypoint.
- `paypointStatus` (string, required) — The paypoint's current status.
- `entryName` (string, required) — The paypoint's entrypoint name, used as the `entry` value on endpoints that target the paypoint.
- `createdAt` (string, required) — When the paypoint was created.
- `updatedAt` (string, required) — When the paypoint was last updated.
- `_links` (PaypointLinks, required) — Hypermedia links for the paypoint resource.
- `businessReference` (string, optional, nullable) — The reference of the business the paypoint belongs to.
- `paypointType` (string, optional, nullable) — The paypoint type, for example `merchant`.
- `doingBusinessAs` (string, optional, nullable) — The name the paypoint does business as (DBA).
- `description` (string, optional, nullable) — A free-text description of the paypoint.
- `website` (string, optional, nullable) — The paypoint's website URL.
- `timezone` (string, optional, nullable) — The paypoint's time zone.
- `customerServicePhone` (string, optional, nullable) — The customer service phone number.
- `customerServiceEmail` (string, optional, nullable) — The customer service email address.
- `externalId` (string, optional, nullable) — Your own identifier for the paypoint.

### PayabliErrorBodyResponseData

Object with detailed error context.

- `explanation` (string, optional) — Human-readable explanation of what happened.
- `todoAction` (string, optional) — Suggested resolution.

### PaypointLinks

Hypermedia links for a paypoint resource.

- `self` (string, optional) — Relative path to the paypoint resource.
- `business` (string, optional) — Relative path to the business the paypoint belongs to.

## Examples

**Response**

```json
{
  "success": true,
  "message": "Organization retrieved successfully",
  "traceId": "0HNPE4LGV825M:0000001D",
  "data": {
    "paypointReference": "a8806f02-23b3-4f6d-bba3-42e1b94326ea",
    "parentPaypointReference": "3c7f1a9e-5d2b-4e84-a6c0-8b1f4d7e2a95",
    "paypointStatus": "pending",
    "entryName": "8cfec329267",
    "createdAt": "2026-10-20T22:20:37.029589",
    "updatedAt": "2026-10-20T22:20:37.029589",
    "_links": {
      "self": "/v2/organizations/a8806f02-23b3-4f6d-bba3-42e1b94326ea",
      "business": "/v2/businesses/6e2b9d14-7a3c-4f58-b1e6-0c9d3a5f8e27"
    },
    "businessReference": "6e2b9d14-7a3c-4f58-b1e6-0c9d3a5f8e27",
    "paypointType": "organization",
    "doingBusinessAs": "PropertyManager Pro",
    "description": "Property management software partner",
    "website": "https://example.com",
    "timezone": "America/New_York",
    "externalId": "pmp-org-001"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api-sandbox.payabli.com/api/v2/organizations/a8806f02-23b3-4f6d-bba3-42e1b94326ea"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://api-sandbox.payabli.com/api/v2/organizations/a8806f02-23b3-4f6d-bba3-42e1b94326ea';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/v2/organizations/a8806f02-23b3-4f6d-bba3-42e1b94326ea"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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/v2/organizations/a8806f02-23b3-4f6d-bba3-42e1b94326ea")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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/v2/organizations/a8806f02-23b3-4f6d-bba3-42e1b94326ea")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/v2/organizations/a8806f02-23b3-4f6d-bba3-42e1b94326ea', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/v2/organizations/a8806f02-23b3-4f6d-bba3-42e1b94326ea");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/v2/organizations/a8806f02-23b3-4f6d-bba3-42e1b94326ea")! 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()
```