Skip to main content
POST
Send a connection request

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new UserConnection resource

requester
string<iri-reference>
Example:

"/api/v1/users/1"

recipient
string<iri-reference>
Example:

"/api/v1/users/1"

status
string
default:pending

Response

UserConnection resource created

id
integer
read-only
requester
object
recipient
object
status
string
default:pending
dateCreated
string<date-time>
read-only
dateUpdated
string<date-time>
read-only
dateAccepted
string<date-time> | null
dateCancelled
string<date-time> | null
cooldownEndDate
string<date-time> | null
read-only