Skip to main content

List Users

POST 
/user-svc/users

Fetches a list of users with optional query filters and pagination.

Request​

Body

Get Users Request

    query

    object

    count boolean

    Count true means return the count of the dataset filtered by Filters without after or limit.

    filters

    object[]

    Filters are filtering options of a query. It is advised to use It's advised to use helper functions in your respective client library such as filter constructors (all, equal, contains, startsWith) and field selectors (field, fields, id) for easier access.

  • Array [

    • fields string[]
    jsonValues string

    JSONValues is a JSON marshalled array of values. It's JSON marhalled due to the limitations of the Swaggo -> OpenAPI 2.0 -> OpenAPI Go generator toolchain.

    op string

    Possible values: [equals, containsSubstring, startsWith, intersects, isInList]

  • ]

    • jsonAfter string

    JSONAfter is used for cursor-based pagination, which is more effective in scalable and distributed environments compared to offset-based pagination.

    JSONAfter is a JSON encoded string due to limitations of Swaggo (ie. []interface{} generates []map[stirng]interface{}).

    limit integer

    Limit the number of records in the result set.

    orderBys

    object[]

    OrderBys order the result set.

  • Array [

    • desc boolean

    Desc indicates whether the sorting should be in descending order.

    field string

    The field by which to order the results

    randomize boolean

    Randomize indicates that the results should be randomized instead of ordered by the field and desc criteria

  • ]

Responses​

List of users retrieved successfully

Schema

    after string
    count integer

    users

    object[]

  • Array [

    • contacts

    object[]

    Contacts are used for login and identification purposes.

  • Array [

    • createdAt string
    deletedAt string
    id string

    The unique identifier, which can be a URL.

    Example values: "joe12" (singulatron username), "twitter.com/thejoe" (twitter url), "joe@joesdomain.com" (email)

    isPrimary boolean

    If this is the primary contact method

    platform string

    Platform of the contact (e.g., "email", "phone", "twitter")

    updatedAt string
    userId string
    value string

    Value is the platform local unique identifier. Ie. while the id of a Twitter contact is twitter.com/thejoe, the value will be only thejoe. For email and phones the id and the value will be the same. This field mostly exists for display purposes.

    Example values: "joe12" (singulatron username), "thejoe" (twitter username), "joe@joesdomain.com" (email)

    verified boolean

    Whether the contact is verified

  • ]

    • createdAt string
    deletedAt string
    id string
    name string

    Full name of the organization.

    passwordHash string
    slug string

    URL-friendly unique (inside the Singularon platform) identifier for the user.

    updatedAt string

  • ]

Loading...