Broker Me

GET

/api/v1/broker/me

const url = 'https://example.com/api/v1/broker/me';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/broker/me

Responses

200

Successful Response

application/json

BrokerMeRead

object

required

string format: uuid

email

required

Email

string

full_name

Any of:

string
null

string

role

required

Role

string

Allowed values: admin member

brokerage

required

BrokerBrokerageRead

object

required

string format: uuid

name

required

Name

string

slug

required

Slug

string

logo_url

Any of:

string
null

string

active_states

Any of:

Array<string>
null

Array<string>

Example

{
  "role": "admin"
}