Skip to content
Authrim

List user relationships

GET
/api/admin/users/{id}/relationships
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/users/example/relationships?direction=incoming' \
  --header 'Authorization: Bearer <token>'

Lists active incoming and/or outgoing access-graph relationships for a user.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Query Parameters

Section titled “Query Parameters ”
direction
string
Allowed values: incoming outgoing

Return only incoming or outgoing relationships. Omit for both.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Active incoming and outgoing user relationships.

Media type application/json
object
user_id
required
string
outgoing_relationships
Array<object>
object
key
additional properties
incoming_relationships
Array<object>
object
key
additional properties
key
additional properties
Example 
{
  "user_id": "user_123",
  "outgoing_relationships": [
    {
      "id": "rel_123",
      "subject_id": "user_123",
      "related_subject_id": "user_456",
      "relationship_type": "manager_of",
      "expires_at": 1770086400000,
      "created_at": 1770000000000,
      "related_email": "[email protected]",
      "related_name": "Target User"
    }
  ],
  "incoming_relationships": [
    {
      "id": "rel_456",
      "relationship_type": "guardian_of",
      "subject_id": "user_789",
      "subject_email": "[email protected]",
      "subject_name": "Guardian User",
      "expires_at": null,
      "created_at": 1770000000000
    }
  ]
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}