Skip to main content
GET
Get User Relationship

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

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

Path Parameters

user_id
string
required

Query Parameters

relationshipType
enum<string>
required

Part of the identifier, mirroring DeleteUserRelationship: a user holds at most one relationship per type, but may hold several types, so user_id alone does not name a single relationship.

Available options:
USER_RELATIONSHIP_TYPE_UNSPECIFIED,
USER_RELATIONSHIP_TYPE_MANAGER

Response

200 - application/json

Success

data
data · object