Skip to main content
GET
/
bridge
/
api
/
v1
/
workspaces
/
{workspaceId}
/
users
/
{userId}
Retrieve an internal user by ID
curl --request GET \
  --url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/users/{userId} \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/users/{userId}"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/users/{userId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/users/{userId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/users/{userId}"

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

req.Header.Add("x-api-key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/users/{userId}")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/users/{userId}")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "cellphone": "+14084029292",
  "languageCode": "EN"
}

Authorizations

x-api-key
string
header
required

Copy the API key as provided by the Bridge Console.

Path Parameters

workspaceId
string<uuid>
required

Unique identifier of the workspace (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

userId
string<uuid>
required

Unique identifier of the internal user (UUID v4).

Example:

"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8"

Response

Successful Response

Response body for internal-user (human agent) read operations.

id
string
required

Unique identifier for the internal user (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

status
enum<string>
required

'active' when the internal user is live, 'disabled' when the user has been removed.

Available options:
active,
disabled
Examples:

"active"

"disabled"

createdAt
string
required

Timestamp when the internal user was created.

Example:

"2003-04-10T08:00:00.000Z"

updatedAt
string
required

Timestamp when the internal user was last updated.

Example:

"2003-04-10T08:00:00.000Z"

firstName
string | null

Internal user's first name.

Example:

"John"

lastName
string | null

Internal user's last name.

Example:

"Doe"

email
string | null

Internal user's email address.

Example:

"john.doe@example.com"

cellphone
string | null

Internal user's cellphone number.

Example:

"+14084029292"

languageCode
enum<string> | null

Language code of the internal user.

Available options:
ES,
EN
Example:

"EN"