{
    "componentChunkName": "component---src-templates-post-js",
    "path": "/en/v1/club/get-users-club/",
    "result": {"data":{"markdownRemark":{"htmlAst":{"type":"element","tagName":"div","properties":{},"children":[{"type":"element","tagName":"h2","properties":{"id":"get-students","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#get-students","ariaLabel":"get students permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Get Students"}]},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"This is the endpoint that will return all students from a Members Area. These can be students who have made a purchase, who have been imported, or who have joined with free registration."}]},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Students or users can have the following roles in the Members Area: "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"STUDENT"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"FREE_STUDENT"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"OWNER"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ADMIN"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"CONTENT_EDITOR"}]},{"type":"text","value":" or "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"MODERATOR"}]},{"type":"text","value":". This means:"}]},{"type":"element","tagName":"row","properties":{},"children":[{"type":"text","value":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"},{"type":"element","tagName":"table","properties":{},"children":[{"type":"element","tagName":"thead","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Role"}]},{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Definition"}]}]}]},{"type":"element","tagName":"tbody","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"STUDENT"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student"}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"FREE_STUDENT"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student with free access"}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"OWNER"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Owner of the Members Area."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ADMIN"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Administrator of the Members Area."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"CONTENT_EDITOR"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Content Editor."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"MODERATOR"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Moderator of the Members Area."}]}]}]}]}]},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"For Plus Access, students can have the following status in the "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"plus_access"}]},{"type":"text","value":" attribute: "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"WITHOUT_PLUS_ACCESS"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"HOLDER"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"DEPENDENT"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"HOLDER_WITH_DEPENDENTS"}]},{"type":"text","value":" or "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"HOLDER_WITHOUT_DEPENDENTS"}]},{"type":"text","value":". This means:"}]},{"type":"element","tagName":"row","properties":{},"children":[{"type":"text","value":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"},{"type":"element","tagName":"table","properties":{},"children":[{"type":"element","tagName":"thead","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Status"}]},{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Definition"}]}]}]},{"type":"element","tagName":"tbody","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"WITHOUT_PLUS_ACCESS"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student does not have Plus Access."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"HOLDER"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student is the Plus Access holder."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"HOLDER_WITH_DEPENDENTS"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student is the holder with dependents."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"HOLDER_WITHOUT_DEPENDENTS"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student is the holder without dependents."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"DEPENDENT"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student is a dependent of the holder"}]}]}]}]}]},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Student status can be: "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ACTIVE"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BLOCKED"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BLOCKED_BY_OWNER"}]},{"type":"text","value":" or "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"OVERDUE"}]},{"type":"text","value":"."}]},{"type":"element","tagName":"row","properties":{},"children":[{"type":"text","value":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"},{"type":"element","tagName":"table","properties":{},"children":[{"type":"element","tagName":"thead","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Status"}]},{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Definition"}]}]}]},{"type":"element","tagName":"tbody","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ACTIVE"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student active in the Members Area."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BLOCKED"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student blocked in the Members Area."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BLOCKED_BY_OWNER"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student blocked by the Producer or Administrator of the Members Area."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"OVERDUE"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student with expired subscription."}]}]}]}]}]},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"The student types returned in the "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"type"}]},{"type":"text","value":" attribute can be: "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BUYER"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"IMPORTED"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"FREE"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"OWNER"}]},{"type":"text","value":" or "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"GUEST"}]},{"type":"text","value":"."}]},{"type":"element","tagName":"row","properties":{},"children":[{"type":"text","value":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"},{"type":"element","tagName":"table","properties":{},"children":[{"type":"element","tagName":"thead","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Status"}]},{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Definition"}]}]}]},{"type":"element","tagName":"tbody","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BUYER"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student who made the purchase access to the Members Area."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"IMPORTED"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student imported to the Members Area."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"FREE"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Student with free access."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"OWNER"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Owner of the Members Area."}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"GUEST"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Guest in the Members Area."}]}]}]}]}]},{"type":"element","tagName":"h3","properties":{"id":"request-parameters","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#request-parameters","ariaLabel":"request parameters permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Request parameters"}]},{"type":"element","tagName":"row","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{},"children":[{"type":"element","tagName":"h4","properties":{"id":"query","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#query","ariaLabel":"query permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Query"}]},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"subdomain","type":"string","isrequired":"true"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Parameter that must be sent in the request and will indicate from which Members Area the data is being requested. The value will be the name of the subdomain defined in the Club settings."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"email","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Parameter that can be sent in the request for the data of a specific student by email. The value can be the complete email or part of it."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]}]},{"type":"element","tagName":"sample-code-loader","properties":{"src":"get-club-users-request"},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tagName":"hr","properties":{},"children":[]},{"type":"element","tagName":"h3","properties":{"id":"return","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#return","ariaLabel":"return permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Return"}]},{"type":"element","tagName":"row","properties":{},"children":[{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"items","type":"array containing objects"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"List of students in the Members Area."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"collapse","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"user_id","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Student Unique Id in Club."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"name","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Student's name."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"email","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Student's email."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"role","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Displays the student's role. These roles can be: "},{"type":"element","tagName":"br","properties":{},"children":[]},{"type":"text","value":"\n"},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"STUDENT"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"FREE_STUDENT"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"OWNER"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ADMIN"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"CONTENT_EDITOR"}]},{"type":"text","value":" or "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"MODERATOR"}]}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"last_access_date","type":"long"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Date of student's last access."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"first_access_date","type":"long"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Date of student's first access."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"locale","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Language in which the user made the purchase, or the language that was used to import the user."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"plus_access","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Displays whether the student has access plus. These types can be: "},{"type":"element","tagName":"br","properties":{},"children":[]},{"type":"text","value":"\n"},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"WITHOUT_PLUS_ACCESS"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"HOLDER"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"DEPENDENT"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"HOLDER_WITH_DEPENDENTS"}]},{"type":"text","value":" or "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"HOLDER_WITHOUT_DEPENDENTS"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"progress","type":"object"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Displays the summary of the student's progress."}]},{"type":"text","value":"\n  "},{"type":"element","tagName":"collapse","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"completed_percentage","type":"double"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Indicates the percentage of completed pages."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"total","type":"long"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Total number of pages in the Members Area."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"completed","type":"long"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Total number of pages completed."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n  "}]},{"type":"text","value":"              \n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"status","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Displays the current status of the student. The status can be: "},{"type":"element","tagName":"br","properties":{},"children":[]},{"type":"text","value":"\n"},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ACTIVE"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BLOCKED"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BLOCKED_BY_OWNER"}]},{"type":"text","value":" or "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"OVERDUE"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"purchase_date","type":"long"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Purchase date."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"access_count","type":"integer"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Number of accesses to the Members Area."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"is_deletable","type":"boolean"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Indicates whether the student can be blocked or not. The value "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"true"}]},{"type":"text","value":" means yes, "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"false"}]},{"type":"text","value":" means no."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"class_id","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Id of the class to which the student is linked."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"type","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Displays the student's type. The type can be: "},{"type":"element","tagName":"br","properties":{},"children":[]},{"type":"text","value":"\n"},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BUYER"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"IMPORTED"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"FREE"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"OWNER"}]},{"type":"text","value":" or "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"GUEST"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"engagement","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Student engagement in the course. Engagement is a metric that measures how well your users are interacting with your product. Each user has their own points that determine whether their engagement is:"},{"type":"element","tagName":"br","properties":{},"children":[]},{"type":"text","value":"\n"},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"NONE"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"LOW"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"MEDIUM"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"HIGH"}]},{"type":"text","value":" or "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"VERY_HIGH"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"page_info","type":"object"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Pagination information, with the possible data:"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"collapse","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"total_results","type":"integer"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"It may not be returned on all endpoints, but it will tell you how many items the entire list has, not considering pagination."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"next_page_token","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"It contains a reference to the next page in the list. It is worth noting that when we request the last page, the "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"page_info"}]},{"type":"text","value":" attribute will not contain the "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"next_page_token"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"prev_page_token","type":"string"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"It contains a reference to the previous page in the list. It is worth noting that when we request the first page, the "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"page_info"}]},{"type":"text","value":" attribute will not contain the "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"prev_page_token"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"results_per_page","type":"integer"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Contains the number of items on the current page. If you want, you can send a maximum value of items you want to receive on each page, such as the query param "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"max_results"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Each endpoint will have a default "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"results_per_page"}]},{"type":"text","value":" and a maximum value of items that can be returned per page. So if you pass a "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"max_results"}]},{"type":"text","value":" greater than that allowed, only the maximum will be returned to you."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"element","tagName":"sample-code-loader","properties":{"src":"get-club-users-response"},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tagName":"sandbox","properties":{},"children":[{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"To test this endpoint in the Sandbox you need to change the base URL to "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"https://sandbox.hotmart.com"}]},{"type":"text","value":" and use the Sandbox environment credential."}]},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Since all data in the Sandbox is fictitious, below is a table with possible values to be used to test each parameter of the request. When you replace the parameter with the value, you will get the scenario described in the table. This shows what you should expect in response to the request."}]},{"type":"element","tagName":"row","properties":{},"children":[{"type":"text","value":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"},{"type":"element","tagName":"table","properties":{},"children":[{"type":"element","tagName":"thead","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Test scenario"}]},{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"HTTP response code"}]},{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Parameter name"}]},{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Values ​​for the parameter"}]}]}]},{"type":"element","tagName":"tbody","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Success"}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"200"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"subdomain"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"my_subdomain"}]}]}]},{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Parameter "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"subdomain"}]},{"type":"text","value":" is required"}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"422"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"no parameters"}]},{"type":"element","tagName":"td","properties":{},"children":[]}]}]}]}]}]}]},"frontmatter":{"description":"It the place to create your course, organize and distribute your content to your students in many media formats.","title":"Get students","tags":["club","users","user","user","students","students","student"],"category":"Members Area","categoryDescription":"It the place to create your course, organize and distribute your content to your students in many media formats.","api":null,"buttonLink":null,"buttonText":null,"buttonIcon":null},"fields":{"langKey":"en","verKey":["/v1"],"slug":"/en/v1/club/get-users-club/"}},"allMarkdownRemark":{"distinct":["en","es","pt-BR"]}},"pageContext":{"category":"club","slug":"/en/v1/club/get-users-club/","pathNoLang":"/v1/club/get-users-club/"}},
    "staticQueryHashes": ["1180253839","1927663127","2095688679","3367957584","3579948671","3996864857","4162568218","4285555676"]}