API docs by Redocly

Site Integration Users API

Download OpenAPI specification:

Endpoints for managing integration users on a site.

/sites/{siteId}/integrations/{integrationId}/users

Authorizations:
IntegrationApiKey
path Parameters
siteId
required
string
integrationId
required
string
query Parameters
includeConnection
boolean

Whether to include connection details in the response

Request Body schema: application/json
userId
string

The unique identifier for the user in the integration

userEmail
string

The email address of the user in the integration

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "userEmail": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "connection": {
    }
}

/sites/{siteId}/integrations/{integrationId}/users

Authorizations:
IntegrationApiKey
path Parameters
siteId
required
string
integrationId
required
string
query Parameters
email
string

Filter users by their email address

limit
integer

Maximum number of users to return

offset
integer

Number of users to skip before starting to collect the result set

enrolmentStatus
string
Enum: "ENROLMENT_PENDING" "ENROLMENT_REQUEST_FAILED" "ENROLMENT_REQUEST_SENT" "PICTURE_VALIDATION_FAILED" "ENROLLED" "CONSENT_DECLINED" "DISENROLMENT_FAILED" "DISENROLLED"

Filter users by their enrollment status

updatedSince
integer

Return users updated since this timestamp

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "connection": {
    }
}

/sites/{siteId}/integrations/{integrationId}/users/{userId}

Authorizations:
IntegrationApiKey
path Parameters
siteId
required
string
integrationId
required
string
userId
required
string
query Parameters
includeConnection
boolean

Whether to include connection details in the response

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "connection": {
    }
}