Search people

Search people.

GET /v0/persons/search

Search people

cURL

curl --request GET \
  --url https://api.tryarchitect.com/v0/persons/search \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.tryarchitect.com/v0/persons/search"

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.tryarchitect.com/v0/persons/search', 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.tryarchitect.com/v0/persons/search",
  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.tryarchitect.com/v0/persons/search"

	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.tryarchitect.com/v0/persons/search")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tryarchitect.com/v0/persons/search")

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

200

{
  "hasMore": true,
  "items": [
    {
      "personId": "<string>",
      "name": "<string>",
      "email": "<string>",
      "domain": "<string>",
      "slug": "<string>",
      "phoneNumber": "2023-11-07T05:31:56Z",
      "linkedinProfileUrl": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>",
  "totalCount": 4503599627370495
}

{
  "code": "VALIDATION_ERROR",
  "detail": "body - name: Name is required; email: Invalid email address",
  "details": [
    {
      "field": "body",
      "issues": [
        {
          "code": "validation_failed",
          "message": "name: Name is required",
          "path": [
            "name"
          ]
        }
      ]
    }
  ],
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 400,
  "title": "Bad Request",
  "type": "https://api.tryarchitect.com/errors/validation_error"
}

{
  "code": "UNAUTHORIZED",
  "detail": "Authentication is required",
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 401,
  "title": "Unauthorized",
  "type": "https://api.tryarchitect.com/errors/unauthorized"
}

{
  "code": "FORBIDDEN",
  "detail": "Multi-tenant API keys are not supported",
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 403,
  "title": "Forbidden",
  "type": "https://api.tryarchitect.com/errors/forbidden"
}

{
  "code": "RATE_LIMITED",
  "detail": "Rate limit exceeded",
  "details": {
    "limit": 100,
    "remaining": 0,
    "resetTime": 1713225600000,
    "retryAfter": 60
  },
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 429,
  "title": "Too Many Requests",
  "type": "https://api.tryarchitect.com/errors/rate_limited"
}

{
  "code": "INTERNAL",
  "detail": "An unexpected error occurred",
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://api.tryarchitect.com/errors/internal"
}

{
  "code": "SERVICE_UNAVAILABLE",
  "detail": "The service is temporarily unavailable",
  "requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
  "status": 503,
  "title": "Service Unavailable",
  "type": "https://api.tryarchitect.com/errors/service_unavailable"
}

Authorizations

x-api-key · string · header · required

API key authentication for the External Actor Gateway

Query Parameters

cursor · string

cursor parameter

limit · number

limit parameter

query · string

query parameter

Response

200

application/json

Successful operation

hasMore · boolean · required

items · object[] · required

Show child attributes

nextCursor · string | null · required

Minimum string length: 1

totalCount · integer | null · required

Required range: 0 <= x <= 9007199254740991