Get Rooms

get

/rooms

query parameters

  • Name
    limit
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    sort_order
    Type
    string
    Is Required
    Reference
    Description
  • Name
    room_name
    Type
    string
    Is Required
    Reference
    Description
  • Name
    owner_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    starts_after
    Type
    string
    Is Required
    Reference
    Description
  • Name
    ends_before
    Type
    string
    Is Required
    Reference
    Description

Body

200OK

Responses

application/json
  • Name
    rooms
    Type
    array
    Is Required
    Reference
    Description
    • Name
      room_id
      Type
      string
      Is Required
      Reference
      Description
    • Name
      disp_name
      Type
      string
      Is Required
      Reference
      Description
    • Name
      description
      Type
      string
      Is Required
      Reference
      Description
    • Name
      category
      Type
      string
      Is Required
      Reference
      Description
    • Name
      created_at
      Type
      string
      Is Required
      Reference
      Description
    • Name
      access_policy
      Type
      string
      Is Required
      Reference
      Description
    • Name
      owner_id
      Type
      string |
      null
      Is Required
      Reference
      Description
    • Name
      locale
      Type
      array
      Is Required
      Reference
      Description
    • Name
      is_home_room
      Type
      boolean |
      null
      Is Required
      Reference
      Description
    • Name
      designer_ids
      Type
      array
      Is Required
      Reference
      Description
    • Name
      moderator_ids
      Type
      array
      Is Required
      Reference
      Description
  • Name
    total
    Type
    integer
    Is Required
    Reference
    Description
  • Name
    first_id
    Type
    string
    Is Required
    Reference
    Description
  • Name
    last_id
    Type
    string
    Is Required
    Reference
    Description

© 2023 Pocket Worlds. All rights reserved.