Skip to main content
GET
/
v1
/
representatives
cURL
curl --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/representatives
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z",
    "total_items": 123,
    "page_number": 123,
    "page_size": 123,
    "max_page_size": 123,
    "sort_by": "<string>",
    "sort_order": "asc",
    "total_pages": 123
  },
  "response_type": "object",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "created",
      "status_detail": {
        "reason": "unverified",
        "source": "watchtower",
        "code": "<string>",
        "message": "<string>"
      },
      "first_name": "Ron",
      "last_name": "Swanson",
      "dob": "1980-01-01",
      "ssn_last4": "1234",
      "email": "ron.swanson@pawnee.com",
      "mobile_number": "+12128675309",
      "relationship": {
        "primary": true,
        "control": true,
        "owner": true,
        "percent_ownership": 123,
        "title": "<string>"
      },
      "external_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "phone": "<string>",
      "metadata": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

​
request-id
string
​
correlation-id
string

Query Parameters

​
account_id
string<uuid>
​
page_number
integer
default:1
​
page_size
integer
default:100
​
sort_by
string
default:id
​
sort_order
enum<string>
default:asc
Available options:
asc,
desc
​
platform_id
string<uuid>
​
organization_id
string<uuid>
​
level
enum<string>
Available options:
account,
platform

Response

​
meta
object
required
​
response_type
enum<string>
required
Available options:
object,
array,
error,
none
​
data
object[]
required