Skip to main content

Get profiles

Get profiles

Query Parameters
    query object

    Allows for pagination and sorting.

    exclude_attributes boolean

    Allows for optimization by not returning the associated attribute data for the returned profiles

    name string

    object name for filtering

    profile_type_id uuid

    Profile Type ID for filtering

    status string

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

    status value for filtering

    metadata boolean

    Returns batching metadata in the response

Responses

Expected response to a valid request


Schema
    profiles object[]
  • Array [
  • name string
    profile_type_id uuid
    status string

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

    id_proofing_status string

    Possible values: [pending, pass, fail]

    created_at date-time
    updated_at date-time
    attributes object
    property name* string
  • ]
  • _metadata object
    limit integer
    offset integer
    total integer
    next string
    previous string
Loading...