Skip to main content
GET
/
partner
/
partners
List Partners
curl --request GET \
  --url https://api.example.com/partner/partners \
  --header 'Authorization: Bearer <token>'
[
  {
    "org_id": 123,
    "full_name": "<string>",
    "email": "jsmith@example.com",
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "phone": "<string>",
    "role": "partner",
    "is_active": true,
    "user_id": 123,
    "last_login_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
org_id
integer
required
​
role
string | null
​
is_active
boolean | null
​
q
string | null
​
limit
integer
default:200
Required range: 1 <= x <= 500
​
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

​
org_id
integer
required
​
full_name
string
required
​
email
string<email>
required
​
id
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
phone
string | null
​
role
string
default:partner
​
is_active
boolean
default:true
​
user_id
integer | null
​
last_login_at
string<date-time> | null