Skip to main content

Return Users from user organisation

GET 

/api/v1/organisations/me/users

Return Users from user organisation

Request

Query Parameters

    include string

    Include associations (delimited with comma). Available associations: specializations, businesses_managed, access_groups

    permissions_role string

    Possible values: [admin, group_manager, business_manager]

    Filtering per permissions role is only possible for admins, group managers can only view business managers

    page int32

    Default value: 1

    Page offset to fetch.

    per_page int32

    Default value: 50

    Number of results to return per page.

Responses

Return all group manager & business manager users from user organisation

Schema

    data

    object[]

    required

  • Array [

  • id stringrequired
    type stringrequired

    Possible values: [users]

    links

    object

    required

    self stringrequired

    attributes

    object

    required

    accepted-food-detective boolean
    allergies string

    avatar

    object

    url stringrequired
    birthday string
    city string
    confirmed boolean
    connected-to-partoo boolean
    country string
    country-code string
    deleted boolean
    detected-language
    email string
    favourite-drink string
    favourite-food string
    food-detective-status string
    gender string
    invitation-accepted-at string
    invited-at string
    language string
    monthly-bars-budget number
    monthly-delivery-takeaway-budget number
    monthly-restaurants-budget number
    name string
    partoo-user-id string
    permissions-role string
    phone string
    phone-country-code string
    phone-country-prefix string
    post-code string
    recovery-email string
    region
    region-code string
    registered-via-oauth boolean
    reviews-count number
    role string
    sign-in-count number
    street string
    street-number string
    subscription-not-terminated boolean
    unconfirmed-email string

    relationships

    object

    required

    specializations

    object

    required

    links

    object

    required

    self stringrequired
    related stringrequired
  • ]

  • meta

    object

    required

    total-count numberrequired
    total-pages numberrequired
Loading...