v1

latestSwagger 2.02026-07-134146194.6 MB

ConnectConfigurations

Returns users from the configured Connect service.

<ds-inlinemessage> To use this method, you must be an account administrator and Connect must be enabled on your account. </ds-inlinemessage>

get/v2.1/accounts/{accountId}/connect/{connectId}/users

accountIdstring required

The external account number (int) or account ID GUID.

connectIdstring required

The ID of the custom Connect configuration being accessed.

countstring

The maximum number of results to return.

Use start_position to specify the number of results to skip.

email_substringstring

Filters returned user records by full email address or a substring of email address.

list_included_usersstring

start_positionstring

The zero-based index of the result from which to start returning results.

Use with count to limit the number of results.

The default value is 0.

statusstring

Filters the results by user status. You can specify a comma-separated list of the following statuses:

user_name_substringstring

Filters results based on a full or partial user name.

Note: When you enter a partial user name, you do not use a wildcard character.

Successful response.