Wingfield Partner API Docs

List user relations for your external service.

Supported filters:

externalUserId: exact match for your external user identifier
status: PENDING, ACCEPTED, REJECTED

Path Parameters

externalServiceId*string

External service ID (UUID).

Formatuuid

Query Parameters

offset?integer

Number of items to skip.

Default0

Range0 <= value

limit?integer

Maximum number of items to return.

Default50

Range1 <= value <= 100

externalUserId?string

Optional exact-match filter by your external user ID.

status?string

Optional user relation status filter.

Value in"PENDING" | "ACCEPTED" | "REJECTED"

Response

200

items*array<||>

totalCount*integer

Range0 <= value

Error Responses

400

invalid_schema

Request validation failed.

401

missing_api_token

No authentication token provided.

401

invalid_api_token

Invalid or expired authentication token.

403

scope_permission_denied

Insufficient permissions for this operation.

403

external_service_access_denied

Token does not match the requested external service.

curl -X GET "https://dev.wingfield.systems/api/v1/external-services/497f6eca-6276-4993-bfeb-53cbbbba6f08/user-relations"

{
  "items": [
    {
      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
      "email": "user@example.com",
      "externalUserId": "string",
      "status": "PENDING",
      "user": null
    }
  ],
  "totalCount": 0
}

{
  "error": {
    "type": "invalid_schema",
    "message": "string",
    "issues": [
      {}
    ]
  }
}

{
  "error": {
    "type": "missing_api_token",
    "message": "string"
  }
}

{
  "error": {
    "type": "scope_permission_denied",
    "message": "string"
  }
}