Skip to main content
GET
/
agents
List Agents
curl --request GET \
  --url https://api.myupfront.com/v1/agents \
  --header 'x-upfront-key: <api-key>'
[
  {
    "id": "cm5gy0r4m00000cjs97rxc467",
    "email": "[email protected]",
    "date_of_birth": "1990-01-01",
    "first_name": "Jane",
    "last_name": "Doe",
    "profile": {
      "onboarding_complete": true,
      "client_metadata": {},
      "external_id": "<string>"
    },
    "current_brokerage_id": "cm5gy0r4m00000cjs97rxc467",
    "role_assignments": [
      {
        "brokerage_id": "cm5gy0r4m00000cjs97rxc467",
        "office_id": "null",
        "collective_id": "null",
        "role": "BROKER_ADMIN"
      }
    ]
  }
]

Authorizations

​
x-upfront-key
string
header
required

Upfront API key

Query Parameters

​
email
string<email>
​
external_id
string
Example:

"123"

​
limit
number | null
default:10
Example:

100

​
offset
number | null
default:0
Example:

0

Response

200 - application/json

List of agents

​
id
string
required
Example:

"cm5gy0r4m00000cjs97rxc467"

​
email
string<email>
required
​
date_of_birth
string | null
required
Example:

"1990-01-01"

​
first_name
string
required
Required string length: 1 - 255
Example:

"Jane"

​
last_name
string
required
Required string length: 1 - 255
Example:

"Doe"

​
profile
object
required
​
current_brokerage_id
string | null
required

The ID of the brokerage the agent is currently associated with. An agent can only be active with a single brokerage. A null value indicates the agent is not associated with a brokerage.

Example:

"cm5gy0r4m00000cjs97rxc467"

​
role_assignments
object[]
required
Example:
[
  {
    "brokerage_id": "cm5gy0r4m00000cjs97rxc467",
    "office_id": "null",
    "collective_id": "null",
    "role": "BROKER_ADMIN"
  }
]