> 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 user

GET https://api-sandbox.payabli.com/api/User/{userId}

Reference: https://beta-docs.payabli.com/api-reference/user/get-user-in-an-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

- `userId` (long, required) — The Payabli-generated userId value.

### Query parameters

- `entry` (string, optional) — The entrypoint identifier.
- `level` (integer, optional) — Entry level: 0 - partner, 2 - paypoint

## Response

### 200

Success

- `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

## Errors

### 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

### 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
{
  "Access": [
    {
      "roleLabel": "customers",
      "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": [
    {
      "orgEntry": "pilgrim-planner",
      "orgId": 123,
      "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/User/1000000"

querystring = {"entry":"478ae1234"}

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

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

print(response.json())
```

```javascript
const url = 'https://api-sandbox.payabli.com/api/User/1000000?entry=478ae1234';
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/User/1000000?entry=478ae1234"

	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/User/1000000?entry=478ae1234")

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/User/1000000?entry=478ae1234")
  .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/User/1000000?entry=478ae1234', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/User/1000000?entry=478ae1234");
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/User/1000000?entry=478ae1234")! 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()
```