Function useAccessCodes

  • Parameters

    • params: {
          access_code_ids?: string[];
          customer_key?: string;
          device_id?: string;
          limit?: number;
          page_cursor?: null | string;
          user_identifier_key?: string;
      }
      • Optionalaccess_code_ids?: string[]

        IDs of the access codes that you want to retrieve. Specify either device_id or access_code_ids.

      • Optionalcustomer_key?: string

        Customer key for which you want to list access codes.

      • Optionaldevice_id?: string

        ID of the device for which you want to list access codes. Specify either device_id or access_code_ids.

      • Optionallimit?: number

        Numerical limit on the number of access codes to return.

      • Optionalpage_cursor?: null | string

        Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

      • Optionaluser_identifier_key?: string

        Your user ID for the user by which to filter access codes.

    Returns UseSeamQueryResultLegacy<"accessCodes", UseAccessCodesData>