Skip to main content

Run an advanced search for profiles, without saving the query​

Run an advanced search for profiles, without saving the query

Query Parameters
  • query object

    Allows for pagination and sorting using the deepObject notation.


    resource?query[limit]=50&query[offset]=0&query[order]=label


    ParameterDescriptionDefault
    limitLimits the number of results returned100
    offsetReturns the results starting at the value provided0
    orderAllows you to determine the order in which the data is returned (not available on profile attributes)id
    Example: query[limit]=100&query[offset]=50&query[order]=created_at
Request Body required
  • advanced_search object
  • label string

    the label

  • condition_rules_attributes object[]

    The condition rules attributes

    anyOf

  • type string

    Possible values: [ProfileTypeRule]

    The type

  • comparison_operator string

    Possible values: [==, !=]

    The operator to use for comparison

  • value uuid

    The value

Responses

Expected response to a valid request


Schema
  • profiles object[]
  • id uuid

    the id

  • uid string

    Possible values: >= 32 characters and <= 32 characters

    the uid

  • name string

    the name

  • profile_type_id uuid

    The profile type id

  • status string

    Possible values: [Active, Inactive, On Leave, Terminated]

    the status

  • id_proofing_status string

    Possible values: [pending, pass, fail]

    the id profing status

  • created_at date-time

    the created at time

  • updated_at date-time

    the updated at time

  • attributes object

    the attributes

  • property name* string
Loading...