YAyapily
Users

Get Users

Retrieves all users created in your application for a specified applicationUserId using the filter[applicationUserId] query parameter. If filter[applicationUserId] is not provided, the response will include up to 50,000 users.

get/users

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Query parameters

filter[applicationUserId]string[]

Optional. Filter records based on the list of applicationUserId users provided.

Response

Ok

uuidstring uuid

A unique identifier for the 'User' assigned by Yapily.

applicationUuidstring uuid

Unique identifier of the application the user is associated with.

applicationUserIdstring

Conditional. The user-friendly reference to the User.

referenceIdstring
createdAtstring date-time

Date and time of when the user was created.

vopOptOutboolean

Optional. A flag to indicate whether the user has opted out of VOP.

Changes

No recorded changes to this operation across all 4 revisions of this API.